2 * arch/powerpc/platforms/powermac/low_i2c.c
4 * Copyright (C) 2003-2005 Ben. Herrenschmidt (benh@kernel.crashing.org)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
11 * The linux i2c layer isn't completely suitable for our needs for various
12 * reasons ranging from too late initialisation to semantics not perfectly
13 * matching some requirements of the apple platform functions etc...
15 * This file thus provides a simple low level unified i2c interface for
16 * powermac that covers the various types of i2c busses used in Apple machines.
17 * For now, keywest, PMU and SMU, though we could add Cuda, or other bit
18 * banging busses found on older chipstes in earlier machines if we ever need
21 * The drivers in this file are synchronous/blocking. In addition, the
22 * keywest one is fairly slow due to the use of msleep instead of interrupts
23 * as the interrupt is currently used by i2c-keywest. In the long run, we
24 * might want to get rid of those high-level interfaces to linux i2c layer
25 * either completely (converting all drivers) or replacing them all with a
26 * single stub driver on top of this one. Once done, the interrupt will be
27 * available for our use.
33 #include <linux/types.h>
34 #include <linux/sched.h>
35 #include <linux/init.h>
36 #include <linux/module.h>
37 #include <linux/adb.h>
38 #include <linux/pmu.h>
39 #include <linux/delay.h>
40 #include <linux/completion.h>
41 #include <linux/platform_device.h>
42 #include <linux/interrupt.h>
43 #include <linux/completion.h>
44 #include <linux/timer.h>
45 #include <linux/mutex.h>
46 #include <asm/keylargo.h>
47 #include <asm/uninorth.h>
50 #include <asm/machdep.h>
52 #include <asm/pmac_pfunc.h>
53 #include <asm/pmac_low_i2c.h>
56 #define DBG(x...) do {\
57 printk(KERN_DEBUG "low_i2c:" x); \
64 #define DBG_LOW(x...) do {\
65 printk(KERN_DEBUG "low_i2c:" x); \
72 static int pmac_i2c_force_poll = 1;
75 * A bus structure. Each bus in the system has such a structure associated.
79 struct list_head link;
80 struct device_node *controller;
81 struct device_node *busnode;
84 struct i2c_adapter *adapter;
86 int channel; /* some hosts have multiple */
87 int mode; /* current mode */
90 int polled; /* open mode */
91 struct platform_device *platform_dev;
94 int (*open)(struct pmac_i2c_bus *bus);
95 void (*close)(struct pmac_i2c_bus *bus);
96 int (*xfer)(struct pmac_i2c_bus *bus, u8 addrdir, int subsize,
97 u32 subaddr, u8 *data, int len);
100 static LIST_HEAD(pmac_i2c_busses);
103 * Keywest implementation
106 struct pmac_i2c_host_kw
108 struct mutex mutex; /* Access mutex for use by
110 void __iomem *base; /* register base address */
111 int bsteps; /* register stepping */
112 int speed; /* speed */
120 struct completion complete;
122 struct timer_list timeout_timer;
125 /* Register indices */
137 /* The Tumbler audio equalizer can be really slow sometimes */
138 #define KW_POLL_TIMEOUT (2*HZ)
141 #define KW_I2C_MODE_100KHZ 0x00
142 #define KW_I2C_MODE_50KHZ 0x01
143 #define KW_I2C_MODE_25KHZ 0x02
144 #define KW_I2C_MODE_DUMB 0x00
145 #define KW_I2C_MODE_STANDARD 0x04
146 #define KW_I2C_MODE_STANDARDSUB 0x08
147 #define KW_I2C_MODE_COMBINED 0x0C
148 #define KW_I2C_MODE_MODE_MASK 0x0C
149 #define KW_I2C_MODE_CHAN_MASK 0xF0
151 /* Control register */
152 #define KW_I2C_CTL_AAK 0x01
153 #define KW_I2C_CTL_XADDR 0x02
154 #define KW_I2C_CTL_STOP 0x04
155 #define KW_I2C_CTL_START 0x08
157 /* Status register */
158 #define KW_I2C_STAT_BUSY 0x01
159 #define KW_I2C_STAT_LAST_AAK 0x02
160 #define KW_I2C_STAT_LAST_RW 0x04
161 #define KW_I2C_STAT_SDA 0x08
162 #define KW_I2C_STAT_SCL 0x10
164 /* IER & ISR registers */
165 #define KW_I2C_IRQ_DATA 0x01
166 #define KW_I2C_IRQ_ADDR 0x02
167 #define KW_I2C_IRQ_STOP 0x04
168 #define KW_I2C_IRQ_START 0x08
169 #define KW_I2C_IRQ_MASK 0x0F
171 /* State machine states */
181 #define WRONG_STATE(name) do {\
182 printk(KERN_DEBUG "KW: wrong state. Got %s, state: %s " \
184 name, __kw_state_names[host->state], isr); \
187 static const char *__kw_state_names[] = {
196 static inline u8 __kw_read_reg(struct pmac_i2c_host_kw *host, reg_t reg)
198 return readb(host->base + (((unsigned int)reg) << host->bsteps));
201 static inline void __kw_write_reg(struct pmac_i2c_host_kw *host,
204 writeb(val, host->base + (((unsigned)reg) << host->bsteps));
205 (void)__kw_read_reg(host, reg_subaddr);
208 #define kw_write_reg(reg, val) __kw_write_reg(host, reg, val)
209 #define kw_read_reg(reg) __kw_read_reg(host, reg)
211 static u8 kw_i2c_wait_interrupt(struct pmac_i2c_host_kw *host)
216 for (i = 0; i < 1000; i++) {
217 isr = kw_read_reg(reg_isr) & KW_I2C_IRQ_MASK;
221 /* This code is used with the timebase frozen, we cannot rely
222 * on udelay nor schedule when in polled mode !
223 * For now, just use a bogus loop....
226 for (j = 1; j < 100000; j++)
234 static void kw_i2c_do_stop(struct pmac_i2c_host_kw *host, int result)
236 kw_write_reg(reg_control, KW_I2C_CTL_STOP);
237 host->state = state_stop;
238 host->result = result;
242 static void kw_i2c_handle_interrupt(struct pmac_i2c_host_kw *host, u8 isr)
246 DBG_LOW("kw_handle_interrupt(%s, isr: %x)\n",
247 __kw_state_names[host->state], isr);
249 if (host->state == state_idle) {
250 printk(KERN_WARNING "low_i2c: Keywest got an out of state"
251 " interrupt, ignoring\n");
252 kw_write_reg(reg_isr, isr);
257 printk(KERN_WARNING "low_i2c: Timeout in i2c transfer"
259 if (host->state != state_stop) {
260 kw_i2c_do_stop(host, -EIO);
263 ack = kw_read_reg(reg_status);
264 if (ack & KW_I2C_STAT_BUSY)
265 kw_write_reg(reg_status, 0);
266 host->state = state_idle;
267 kw_write_reg(reg_ier, 0x00);
269 complete(&host->complete);
273 if (isr & KW_I2C_IRQ_ADDR) {
274 ack = kw_read_reg(reg_status);
275 if (host->state != state_addr) {
276 WRONG_STATE("KW_I2C_IRQ_ADDR");
277 kw_i2c_do_stop(host, -EIO);
279 if ((ack & KW_I2C_STAT_LAST_AAK) == 0) {
280 host->result = -ENXIO;
281 host->state = state_stop;
282 DBG_LOW("KW: NAK on address\n");
285 kw_i2c_do_stop(host, 0);
287 host->state = state_read;
289 kw_write_reg(reg_control,
292 host->state = state_write;
293 kw_write_reg(reg_data, *(host->data++));
297 kw_write_reg(reg_isr, KW_I2C_IRQ_ADDR);
300 if (isr & KW_I2C_IRQ_DATA) {
301 if (host->state == state_read) {
302 *(host->data++) = kw_read_reg(reg_data);
304 kw_write_reg(reg_isr, KW_I2C_IRQ_DATA);
306 host->state = state_stop;
307 else if (host->len == 1)
308 kw_write_reg(reg_control, 0);
309 } else if (host->state == state_write) {
310 ack = kw_read_reg(reg_status);
311 if ((ack & KW_I2C_STAT_LAST_AAK) == 0) {
312 DBG_LOW("KW: nack on data write\n");
313 host->result = -EFBIG;
314 host->state = state_stop;
315 } else if (host->len) {
316 kw_write_reg(reg_data, *(host->data++));
319 kw_i2c_do_stop(host, 0);
321 WRONG_STATE("KW_I2C_IRQ_DATA");
322 if (host->state != state_stop)
323 kw_i2c_do_stop(host, -EIO);
325 kw_write_reg(reg_isr, KW_I2C_IRQ_DATA);
328 if (isr & KW_I2C_IRQ_STOP) {
329 kw_write_reg(reg_isr, KW_I2C_IRQ_STOP);
330 if (host->state != state_stop) {
331 WRONG_STATE("KW_I2C_IRQ_STOP");
334 host->state = state_idle;
336 complete(&host->complete);
339 /* Below should only happen in manual mode which we don't use ... */
340 if (isr & KW_I2C_IRQ_START)
341 kw_write_reg(reg_isr, KW_I2C_IRQ_START);
345 /* Interrupt handler */
346 static irqreturn_t kw_i2c_irq(int irq, void *dev_id)
348 struct pmac_i2c_host_kw *host = dev_id;
351 spin_lock_irqsave(&host->lock, flags);
352 del_timer(&host->timeout_timer);
353 kw_i2c_handle_interrupt(host, kw_read_reg(reg_isr));
354 if (host->state != state_idle) {
355 host->timeout_timer.expires = jiffies + KW_POLL_TIMEOUT;
356 add_timer(&host->timeout_timer);
358 spin_unlock_irqrestore(&host->lock, flags);
362 static void kw_i2c_timeout(unsigned long data)
364 struct pmac_i2c_host_kw *host = (struct pmac_i2c_host_kw *)data;
367 spin_lock_irqsave(&host->lock, flags);
368 kw_i2c_handle_interrupt(host, kw_read_reg(reg_isr));
369 if (host->state != state_idle) {
370 host->timeout_timer.expires = jiffies + KW_POLL_TIMEOUT;
371 add_timer(&host->timeout_timer);
373 spin_unlock_irqrestore(&host->lock, flags);
376 static int kw_i2c_open(struct pmac_i2c_bus *bus)
378 struct pmac_i2c_host_kw *host = bus->hostdata;
379 mutex_lock(&host->mutex);
383 static void kw_i2c_close(struct pmac_i2c_bus *bus)
385 struct pmac_i2c_host_kw *host = bus->hostdata;
386 mutex_unlock(&host->mutex);
389 static int kw_i2c_xfer(struct pmac_i2c_bus *bus, u8 addrdir, int subsize,
390 u32 subaddr, u8 *data, int len)
392 struct pmac_i2c_host_kw *host = bus->hostdata;
393 u8 mode_reg = host->speed;
394 int use_irq = host->irq != NO_IRQ && !bus->polled;
396 /* Setup mode & subaddress if any */
398 case pmac_i2c_mode_dumb:
400 case pmac_i2c_mode_std:
401 mode_reg |= KW_I2C_MODE_STANDARD;
405 case pmac_i2c_mode_stdsub:
406 mode_reg |= KW_I2C_MODE_STANDARDSUB;
410 case pmac_i2c_mode_combined:
411 mode_reg |= KW_I2C_MODE_COMBINED;
417 /* Setup channel & clear pending irqs */
418 kw_write_reg(reg_isr, kw_read_reg(reg_isr));
419 kw_write_reg(reg_mode, mode_reg | (bus->channel << 4));
420 kw_write_reg(reg_status, 0);
422 /* Set up address and r/w bit, strip possible stale bus number from
425 kw_write_reg(reg_addr, addrdir & 0xff);
427 /* Set up the sub address */
428 if ((mode_reg & KW_I2C_MODE_MODE_MASK) == KW_I2C_MODE_STANDARDSUB
429 || (mode_reg & KW_I2C_MODE_MODE_MASK) == KW_I2C_MODE_COMBINED)
430 kw_write_reg(reg_subaddr, subaddr);
432 /* Prepare for async operations */
435 host->state = state_addr;
437 host->rw = (addrdir & 1);
438 host->polled = bus->polled;
440 /* Enable interrupt if not using polled mode and interrupt is
444 /* Clear completion */
445 INIT_COMPLETION(host->complete);
446 /* Ack stale interrupts */
447 kw_write_reg(reg_isr, kw_read_reg(reg_isr));
449 host->timeout_timer.expires = jiffies + KW_POLL_TIMEOUT;
450 add_timer(&host->timeout_timer);
451 /* Enable emission */
452 kw_write_reg(reg_ier, KW_I2C_IRQ_MASK);
455 /* Start sending address */
456 kw_write_reg(reg_control, KW_I2C_CTL_XADDR);
458 /* Wait for completion */
460 wait_for_completion(&host->complete);
462 while(host->state != state_idle) {
465 u8 isr = kw_i2c_wait_interrupt(host);
466 spin_lock_irqsave(&host->lock, flags);
467 kw_i2c_handle_interrupt(host, isr);
468 spin_unlock_irqrestore(&host->lock, flags);
472 /* Disable emission */
473 kw_write_reg(reg_ier, 0);
478 static struct pmac_i2c_host_kw *__init kw_i2c_host_init(struct device_node *np)
480 struct pmac_i2c_host_kw *host;
481 const u32 *psteps, *prate, *addrp;
484 host = kzalloc(sizeof(struct pmac_i2c_host_kw), GFP_KERNEL);
486 printk(KERN_ERR "low_i2c: Can't allocate host for %s\n",
491 /* Apple is kind enough to provide a valid AAPL,address property
492 * on all i2c keywest nodes so far ... we would have to fallback
493 * to macio parsing if that wasn't the case
495 addrp = of_get_property(np, "AAPL,address", NULL);
497 printk(KERN_ERR "low_i2c: Can't find address for %s\n",
502 mutex_init(&host->mutex);
503 init_completion(&host->complete);
504 spin_lock_init(&host->lock);
505 init_timer(&host->timeout_timer);
506 host->timeout_timer.function = kw_i2c_timeout;
507 host->timeout_timer.data = (unsigned long)host;
509 psteps = of_get_property(np, "AAPL,address-step", NULL);
510 steps = psteps ? (*psteps) : 0x10;
511 for (host->bsteps = 0; (steps & 0x01) == 0; host->bsteps++)
513 /* Select interface rate */
514 host->speed = KW_I2C_MODE_25KHZ;
515 prate = of_get_property(np, "AAPL,i2c-rate", NULL);
516 if (prate) switch(*prate) {
518 host->speed = KW_I2C_MODE_100KHZ;
521 host->speed = KW_I2C_MODE_50KHZ;
524 host->speed = KW_I2C_MODE_25KHZ;
527 host->irq = irq_of_parse_and_map(np, 0);
528 if (host->irq == NO_IRQ)
530 "low_i2c: Failed to map interrupt for %s\n",
533 host->base = ioremap((*addrp), 0x1000);
534 if (host->base == NULL) {
535 printk(KERN_ERR "low_i2c: Can't map registers for %s\n",
541 /* Make sure IRQ is disabled */
542 kw_write_reg(reg_ier, 0);
544 /* Request chip interrupt */
545 if (request_irq(host->irq, kw_i2c_irq, 0, "keywest i2c", host))
548 printk(KERN_INFO "KeyWest i2c @0x%08x irq %d %s\n",
549 *addrp, host->irq, np->full_name);
555 static void __init kw_i2c_add(struct pmac_i2c_host_kw *host,
556 struct device_node *controller,
557 struct device_node *busnode,
560 struct pmac_i2c_bus *bus;
562 bus = kzalloc(sizeof(struct pmac_i2c_bus), GFP_KERNEL);
566 bus->controller = of_node_get(controller);
567 bus->busnode = of_node_get(busnode);
568 bus->type = pmac_i2c_bus_keywest;
569 bus->hostdata = host;
570 bus->channel = channel;
571 bus->mode = pmac_i2c_mode_std;
572 bus->open = kw_i2c_open;
573 bus->close = kw_i2c_close;
574 bus->xfer = kw_i2c_xfer;
575 mutex_init(&bus->mutex);
576 if (controller == busnode)
577 bus->flags = pmac_i2c_multibus;
578 list_add(&bus->link, &pmac_i2c_busses);
580 printk(KERN_INFO " channel %d bus %s\n", channel,
581 (controller == busnode) ? "<multibus>" : busnode->full_name);
584 static void __init kw_i2c_probe(void)
586 struct device_node *np, *child, *parent;
588 /* Probe keywest-i2c busses */
590 (np = of_find_compatible_node(np, "i2c","keywest-i2c")) != NULL;){
591 struct pmac_i2c_host_kw *host;
592 int multibus, chans, i;
594 /* Found one, init a host structure */
595 host = kw_i2c_host_init(np);
599 /* Now check if we have a multibus setup (old style) or if we
600 * have proper bus nodes. Note that the "new" way (proper bus
601 * nodes) might cause us to not create some busses that are
602 * kept hidden in the device-tree. In the future, we might
603 * want to work around that by creating busses without a node
606 child = of_get_next_child(np, NULL);
607 multibus = !child || strcmp(child->name, "i2c-bus");
610 /* For a multibus setup, we get the bus count based on the
614 parent = of_get_parent(np);
617 chans = parent->name[0] == 'u' ? 2 : 1;
618 for (i = 0; i < chans; i++)
619 kw_i2c_add(host, np, np, i);
622 (child = of_get_next_child(np, child)) != NULL;) {
623 const u32 *reg = of_get_property(child,
627 kw_i2c_add(host, np, child, *reg);
640 #ifdef CONFIG_ADB_PMU
643 * i2c command block to the PMU
656 static void pmu_i2c_complete(struct adb_request *req)
661 static int pmu_i2c_xfer(struct pmac_i2c_bus *bus, u8 addrdir, int subsize,
662 u32 subaddr, u8 *data, int len)
664 struct adb_request *req = bus->hostdata;
665 struct pmu_i2c_hdr *hdr = (struct pmu_i2c_hdr *)&req->data[1];
666 struct completion comp;
667 int read = addrdir & 1;
671 /* For now, limit ourselves to 16 bytes transfers */
675 init_completion(&comp);
677 for (retry = 0; retry < 16; retry++) {
678 memset(req, 0, sizeof(struct adb_request));
679 hdr->bus = bus->channel;
683 case pmac_i2c_mode_std:
686 hdr->address = addrdir;
687 hdr->mode = PMU_I2C_MODE_SIMPLE;
689 case pmac_i2c_mode_stdsub:
690 case pmac_i2c_mode_combined:
693 hdr->address = addrdir & 0xfe;
694 hdr->comb_addr = addrdir;
695 hdr->sub_addr = subaddr;
696 if (bus->mode == pmac_i2c_mode_stdsub)
697 hdr->mode = PMU_I2C_MODE_STDSUB;
699 hdr->mode = PMU_I2C_MODE_COMBINED;
705 INIT_COMPLETION(comp);
706 req->data[0] = PMU_I2C_CMD;
707 req->reply[0] = 0xff;
708 req->nbytes = sizeof(struct pmu_i2c_hdr) + 1;
709 req->done = pmu_i2c_complete;
712 memcpy(hdr->data, data, len);
715 rc = pmu_queue_request(req);
718 wait_for_completion(&comp);
719 if (req->reply[0] == PMU_I2C_STATUS_OK)
723 if (req->reply[0] != PMU_I2C_STATUS_OK)
726 for (retry = 0; retry < 16; retry++) {
727 memset(req, 0, sizeof(struct adb_request));
729 /* I know that looks like a lot, slow as hell, but darwin
730 * does it so let's be on the safe side for now
734 hdr->bus = PMU_I2C_BUS_STATUS;
736 INIT_COMPLETION(comp);
737 req->data[0] = PMU_I2C_CMD;
738 req->reply[0] = 0xff;
740 req->done = pmu_i2c_complete;
742 rc = pmu_queue_request(req);
745 wait_for_completion(&comp);
747 if (req->reply[0] == PMU_I2C_STATUS_OK && !read)
749 if (req->reply[0] == PMU_I2C_STATUS_DATAREAD && read) {
750 int rlen = req->reply_len - 1;
753 printk(KERN_WARNING "low_i2c: PMU returned %d"
754 " bytes, expected %d !\n", rlen, len);
758 memcpy(data, &req->reply[1], len);
765 static void __init pmu_i2c_probe(void)
767 struct pmac_i2c_bus *bus;
768 struct device_node *busnode;
774 /* There might or might not be a "pmu-i2c" node, we use that
775 * or via-pmu itself, whatever we find. I haven't seen a machine
776 * with separate bus nodes, so we assume a multibus setup
778 busnode = of_find_node_by_name(NULL, "pmu-i2c");
780 busnode = of_find_node_by_name(NULL, "via-pmu");
784 printk(KERN_INFO "PMU i2c %s\n", busnode->full_name);
787 * We add bus 1 and 2 only for now, bus 0 is "special"
789 for (channel = 1; channel <= 2; channel++) {
790 sz = sizeof(struct pmac_i2c_bus) + sizeof(struct adb_request);
791 bus = kzalloc(sz, GFP_KERNEL);
795 bus->controller = busnode;
796 bus->busnode = busnode;
797 bus->type = pmac_i2c_bus_pmu;
798 bus->channel = channel;
799 bus->mode = pmac_i2c_mode_std;
800 bus->hostdata = bus + 1;
801 bus->xfer = pmu_i2c_xfer;
802 mutex_init(&bus->mutex);
803 bus->flags = pmac_i2c_multibus;
804 list_add(&bus->link, &pmac_i2c_busses);
806 printk(KERN_INFO " channel %d bus <multibus>\n", channel);
810 #endif /* CONFIG_ADB_PMU */
819 #ifdef CONFIG_PMAC_SMU
821 static void smu_i2c_complete(struct smu_i2c_cmd *cmd, void *misc)
826 static int smu_i2c_xfer(struct pmac_i2c_bus *bus, u8 addrdir, int subsize,
827 u32 subaddr, u8 *data, int len)
829 struct smu_i2c_cmd *cmd = bus->hostdata;
830 struct completion comp;
831 int read = addrdir & 1;
834 if ((read && len > SMU_I2C_READ_MAX) ||
835 ((!read) && len > SMU_I2C_WRITE_MAX))
838 memset(cmd, 0, sizeof(struct smu_i2c_cmd));
839 cmd->info.bus = bus->channel;
840 cmd->info.devaddr = addrdir;
841 cmd->info.datalen = len;
844 case pmac_i2c_mode_std:
847 cmd->info.type = SMU_I2C_TRANSFER_SIMPLE;
849 case pmac_i2c_mode_stdsub:
850 case pmac_i2c_mode_combined:
851 if (subsize > 3 || subsize < 1)
853 cmd->info.sublen = subsize;
854 /* that's big-endian only but heh ! */
855 memcpy(&cmd->info.subaddr, ((char *)&subaddr) + (4 - subsize),
857 if (bus->mode == pmac_i2c_mode_stdsub)
858 cmd->info.type = SMU_I2C_TRANSFER_STDSUB;
860 cmd->info.type = SMU_I2C_TRANSFER_COMBINED;
866 memcpy(cmd->info.data, data, len);
868 init_completion(&comp);
869 cmd->done = smu_i2c_complete;
871 rc = smu_queue_i2c(cmd);
874 wait_for_completion(&comp);
878 memcpy(data, cmd->info.data, len);
879 return rc < 0 ? rc : 0;
882 static void __init smu_i2c_probe(void)
884 struct device_node *controller, *busnode;
885 struct pmac_i2c_bus *bus;
892 controller = of_find_node_by_name(NULL, "smu-i2c-control");
893 if (controller == NULL)
894 controller = of_find_node_by_name(NULL, "smu");
895 if (controller == NULL)
898 printk(KERN_INFO "SMU i2c %s\n", controller->full_name);
900 /* Look for childs, note that they might not be of the right
901 * type as older device trees mix i2c busses and other thigns
905 (busnode = of_get_next_child(controller, busnode)) != NULL;) {
906 if (strcmp(busnode->type, "i2c") &&
907 strcmp(busnode->type, "i2c-bus"))
909 reg = of_get_property(busnode, "reg", NULL);
913 sz = sizeof(struct pmac_i2c_bus) + sizeof(struct smu_i2c_cmd);
914 bus = kzalloc(sz, GFP_KERNEL);
918 bus->controller = controller;
919 bus->busnode = of_node_get(busnode);
920 bus->type = pmac_i2c_bus_smu;
922 bus->mode = pmac_i2c_mode_std;
923 bus->hostdata = bus + 1;
924 bus->xfer = smu_i2c_xfer;
925 mutex_init(&bus->mutex);
927 list_add(&bus->link, &pmac_i2c_busses);
929 printk(KERN_INFO " channel %x bus %s\n",
930 bus->channel, busnode->full_name);
934 #endif /* CONFIG_PMAC_SMU */
943 struct pmac_i2c_bus *pmac_i2c_find_bus(struct device_node *node)
945 struct device_node *p = of_node_get(node);
946 struct device_node *prev = NULL;
947 struct pmac_i2c_bus *bus;
950 list_for_each_entry(bus, &pmac_i2c_busses, link) {
951 if (p == bus->busnode) {
952 if (prev && bus->flags & pmac_i2c_multibus) {
954 reg = of_get_property(prev, "reg",
958 if (((*reg) >> 8) != bus->channel)
968 p = of_get_parent(p);
972 EXPORT_SYMBOL_GPL(pmac_i2c_find_bus);
974 u8 pmac_i2c_get_dev_addr(struct device_node *device)
976 const u32 *reg = of_get_property(device, "reg", NULL);
981 return (*reg) & 0xff;
983 EXPORT_SYMBOL_GPL(pmac_i2c_get_dev_addr);
985 struct device_node *pmac_i2c_get_controller(struct pmac_i2c_bus *bus)
987 return bus->controller;
989 EXPORT_SYMBOL_GPL(pmac_i2c_get_controller);
991 struct device_node *pmac_i2c_get_bus_node(struct pmac_i2c_bus *bus)
995 EXPORT_SYMBOL_GPL(pmac_i2c_get_bus_node);
997 int pmac_i2c_get_type(struct pmac_i2c_bus *bus)
1001 EXPORT_SYMBOL_GPL(pmac_i2c_get_type);
1003 int pmac_i2c_get_flags(struct pmac_i2c_bus *bus)
1007 EXPORT_SYMBOL_GPL(pmac_i2c_get_flags);
1009 int pmac_i2c_get_channel(struct pmac_i2c_bus *bus)
1011 return bus->channel;
1013 EXPORT_SYMBOL_GPL(pmac_i2c_get_channel);
1016 void pmac_i2c_attach_adapter(struct pmac_i2c_bus *bus,
1017 struct i2c_adapter *adapter)
1019 WARN_ON(bus->adapter != NULL);
1020 bus->adapter = adapter;
1022 EXPORT_SYMBOL_GPL(pmac_i2c_attach_adapter);
1024 void pmac_i2c_detach_adapter(struct pmac_i2c_bus *bus,
1025 struct i2c_adapter *adapter)
1027 WARN_ON(bus->adapter != adapter);
1028 bus->adapter = NULL;
1030 EXPORT_SYMBOL_GPL(pmac_i2c_detach_adapter);
1032 struct i2c_adapter *pmac_i2c_get_adapter(struct pmac_i2c_bus *bus)
1034 return bus->adapter;
1036 EXPORT_SYMBOL_GPL(pmac_i2c_get_adapter);
1038 struct pmac_i2c_bus *pmac_i2c_adapter_to_bus(struct i2c_adapter *adapter)
1040 struct pmac_i2c_bus *bus;
1042 list_for_each_entry(bus, &pmac_i2c_busses, link)
1043 if (bus->adapter == adapter)
1047 EXPORT_SYMBOL_GPL(pmac_i2c_adapter_to_bus);
1049 int pmac_i2c_match_adapter(struct device_node *dev, struct i2c_adapter *adapter)
1051 struct pmac_i2c_bus *bus = pmac_i2c_find_bus(dev);
1055 return (bus->adapter == adapter);
1057 EXPORT_SYMBOL_GPL(pmac_i2c_match_adapter);
1059 int pmac_low_i2c_lock(struct device_node *np)
1061 struct pmac_i2c_bus *bus, *found = NULL;
1063 list_for_each_entry(bus, &pmac_i2c_busses, link) {
1064 if (np == bus->controller) {
1071 return pmac_i2c_open(bus, 0);
1073 EXPORT_SYMBOL_GPL(pmac_low_i2c_lock);
1075 int pmac_low_i2c_unlock(struct device_node *np)
1077 struct pmac_i2c_bus *bus, *found = NULL;
1079 list_for_each_entry(bus, &pmac_i2c_busses, link) {
1080 if (np == bus->controller) {
1087 pmac_i2c_close(bus);
1090 EXPORT_SYMBOL_GPL(pmac_low_i2c_unlock);
1093 int pmac_i2c_open(struct pmac_i2c_bus *bus, int polled)
1097 mutex_lock(&bus->mutex);
1098 bus->polled = polled || pmac_i2c_force_poll;
1100 bus->mode = pmac_i2c_mode_std;
1101 if (bus->open && (rc = bus->open(bus)) != 0) {
1103 mutex_unlock(&bus->mutex);
1108 EXPORT_SYMBOL_GPL(pmac_i2c_open);
1110 void pmac_i2c_close(struct pmac_i2c_bus *bus)
1112 WARN_ON(!bus->opened);
1116 mutex_unlock(&bus->mutex);
1118 EXPORT_SYMBOL_GPL(pmac_i2c_close);
1120 int pmac_i2c_setmode(struct pmac_i2c_bus *bus, int mode)
1122 WARN_ON(!bus->opened);
1124 /* Report me if you see the error below as there might be a new
1125 * "combined4" mode that I need to implement for the SMU bus
1127 if (mode < pmac_i2c_mode_dumb || mode > pmac_i2c_mode_combined) {
1128 printk(KERN_ERR "low_i2c: Invalid mode %d requested on"
1129 " bus %s !\n", mode, bus->busnode->full_name);
1136 EXPORT_SYMBOL_GPL(pmac_i2c_setmode);
1138 int pmac_i2c_xfer(struct pmac_i2c_bus *bus, u8 addrdir, int subsize,
1139 u32 subaddr, u8 *data, int len)
1143 WARN_ON(!bus->opened);
1145 DBG("xfer() chan=%d, addrdir=0x%x, mode=%d, subsize=%d, subaddr=0x%x,"
1146 " %d bytes, bus %s\n", bus->channel, addrdir, bus->mode, subsize,
1147 subaddr, len, bus->busnode->full_name);
1149 rc = bus->xfer(bus, addrdir, subsize, subaddr, data, len);
1153 DBG("xfer error %d\n", rc);
1157 EXPORT_SYMBOL_GPL(pmac_i2c_xfer);
1159 /* some quirks for platform function decoding */
1161 pmac_i2c_quirk_invmask = 0x00000001u,
1162 pmac_i2c_quirk_skip = 0x00000002u,
1165 static void pmac_i2c_devscan(void (*callback)(struct device_node *dev,
1168 struct pmac_i2c_bus *bus;
1169 struct device_node *np;
1170 static struct whitelist_ent {
1175 /* XXX Study device-tree's & apple drivers are get the quirks
1178 /* Workaround: It seems that running the clockspreading
1179 * properties on the eMac will cause lockups during boot.
1180 * The machine seems to work fine without that. So for now,
1181 * let's make sure i2c-hwclock doesn't match about "imic"
1182 * clocks and we'll figure out if we really need to do
1183 * something special about those later.
1185 { "i2c-hwclock", "imic5002", pmac_i2c_quirk_skip },
1186 { "i2c-hwclock", "imic5003", pmac_i2c_quirk_skip },
1187 { "i2c-hwclock", NULL, pmac_i2c_quirk_invmask },
1188 { "i2c-cpu-voltage", NULL, 0},
1189 { "temp-monitor", NULL, 0 },
1190 { "supply-monitor", NULL, 0 },
1194 /* Only some devices need to have platform functions instanciated
1195 * here. For now, we have a table. Others, like 9554 i2c GPIOs used
1196 * on Xserve, if we ever do a driver for them, will use their own
1197 * platform function instance
1199 list_for_each_entry(bus, &pmac_i2c_busses, link) {
1201 (np = of_get_next_child(bus->busnode, np)) != NULL;) {
1202 struct whitelist_ent *p;
1203 /* If multibus, check if device is on that bus */
1204 if (bus->flags & pmac_i2c_multibus)
1205 if (bus != pmac_i2c_find_bus(np))
1207 for (p = whitelist; p->name != NULL; p++) {
1208 if (strcmp(np->name, p->name))
1210 if (p->compatible &&
1211 !of_device_is_compatible(np, p->compatible))
1213 if (p->quirks & pmac_i2c_quirk_skip)
1215 callback(np, p->quirks);
1222 #define MAX_I2C_DATA 64
1224 struct pmac_i2c_pf_inst
1226 struct pmac_i2c_bus *bus;
1228 u8 buffer[MAX_I2C_DATA];
1229 u8 scratch[MAX_I2C_DATA];
1234 static void* pmac_i2c_do_begin(struct pmf_function *func, struct pmf_args *args)
1236 struct pmac_i2c_pf_inst *inst;
1237 struct pmac_i2c_bus *bus;
1239 bus = pmac_i2c_find_bus(func->node);
1241 printk(KERN_ERR "low_i2c: Can't find bus for %s (pfunc)\n",
1242 func->node->full_name);
1245 if (pmac_i2c_open(bus, 0)) {
1246 printk(KERN_ERR "low_i2c: Can't open i2c bus for %s (pfunc)\n",
1247 func->node->full_name);
1251 /* XXX might need GFP_ATOMIC when called during the suspend process,
1252 * but then, there are already lots of issues with suspending when
1253 * near OOM that need to be resolved, the allocator itself should
1254 * probably make GFP_NOIO implicit during suspend
1256 inst = kzalloc(sizeof(struct pmac_i2c_pf_inst), GFP_KERNEL);
1258 pmac_i2c_close(bus);
1262 inst->addr = pmac_i2c_get_dev_addr(func->node);
1263 inst->quirks = (int)(long)func->driver_data;
1267 static void pmac_i2c_do_end(struct pmf_function *func, void *instdata)
1269 struct pmac_i2c_pf_inst *inst = instdata;
1273 pmac_i2c_close(inst->bus);
1278 static int pmac_i2c_do_read(PMF_STD_ARGS, u32 len)
1280 struct pmac_i2c_pf_inst *inst = instdata;
1283 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_read, 0, 0,
1287 static int pmac_i2c_do_write(PMF_STD_ARGS, u32 len, const u8 *data)
1289 struct pmac_i2c_pf_inst *inst = instdata;
1291 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_write, 0, 0,
1295 /* This function is used to do the masking & OR'ing for the "rmw" type
1296 * callbacks. Ze should apply the mask and OR in the values in the
1297 * buffer before writing back. The problem is that it seems that
1298 * various darwin drivers implement the mask/or differently, thus
1299 * we need to check the quirks first
1301 static void pmac_i2c_do_apply_rmw(struct pmac_i2c_pf_inst *inst,
1302 u32 len, const u8 *mask, const u8 *val)
1306 if (inst->quirks & pmac_i2c_quirk_invmask) {
1307 for (i = 0; i < len; i ++)
1308 inst->scratch[i] = (inst->buffer[i] & mask[i]) | val[i];
1310 for (i = 0; i < len; i ++)
1311 inst->scratch[i] = (inst->buffer[i] & ~mask[i])
1312 | (val[i] & mask[i]);
1316 static int pmac_i2c_do_rmw(PMF_STD_ARGS, u32 masklen, u32 valuelen,
1317 u32 totallen, const u8 *maskdata,
1318 const u8 *valuedata)
1320 struct pmac_i2c_pf_inst *inst = instdata;
1322 if (masklen > inst->bytes || valuelen > inst->bytes ||
1323 totallen > inst->bytes || valuelen > masklen)
1326 pmac_i2c_do_apply_rmw(inst, masklen, maskdata, valuedata);
1328 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_write, 0, 0,
1329 inst->scratch, totallen);
1332 static int pmac_i2c_do_read_sub(PMF_STD_ARGS, u8 subaddr, u32 len)
1334 struct pmac_i2c_pf_inst *inst = instdata;
1337 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_read, 1, subaddr,
1341 static int pmac_i2c_do_write_sub(PMF_STD_ARGS, u8 subaddr, u32 len,
1344 struct pmac_i2c_pf_inst *inst = instdata;
1346 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_write, 1,
1347 subaddr, (u8 *)data, len);
1350 static int pmac_i2c_do_set_mode(PMF_STD_ARGS, int mode)
1352 struct pmac_i2c_pf_inst *inst = instdata;
1354 return pmac_i2c_setmode(inst->bus, mode);
1357 static int pmac_i2c_do_rmw_sub(PMF_STD_ARGS, u8 subaddr, u32 masklen,
1358 u32 valuelen, u32 totallen, const u8 *maskdata,
1359 const u8 *valuedata)
1361 struct pmac_i2c_pf_inst *inst = instdata;
1363 if (masklen > inst->bytes || valuelen > inst->bytes ||
1364 totallen > inst->bytes || valuelen > masklen)
1367 pmac_i2c_do_apply_rmw(inst, masklen, maskdata, valuedata);
1369 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_write, 1,
1370 subaddr, inst->scratch, totallen);
1373 static int pmac_i2c_do_mask_and_comp(PMF_STD_ARGS, u32 len,
1375 const u8 *valuedata)
1377 struct pmac_i2c_pf_inst *inst = instdata;
1380 /* Get return value pointer, it's assumed to be a u32 */
1381 if (!args || !args->count || !args->u[0].p)
1385 if (len > inst->bytes)
1388 for (i = 0, match = 1; match && i < len; i ++)
1389 if ((inst->buffer[i] & maskdata[i]) != valuedata[i])
1391 *args->u[0].p = match;
1395 static int pmac_i2c_do_delay(PMF_STD_ARGS, u32 duration)
1397 msleep((duration + 999) / 1000);
1402 static struct pmf_handlers pmac_i2c_pfunc_handlers = {
1403 .begin = pmac_i2c_do_begin,
1404 .end = pmac_i2c_do_end,
1405 .read_i2c = pmac_i2c_do_read,
1406 .write_i2c = pmac_i2c_do_write,
1407 .rmw_i2c = pmac_i2c_do_rmw,
1408 .read_i2c_sub = pmac_i2c_do_read_sub,
1409 .write_i2c_sub = pmac_i2c_do_write_sub,
1410 .rmw_i2c_sub = pmac_i2c_do_rmw_sub,
1411 .set_i2c_mode = pmac_i2c_do_set_mode,
1412 .mask_and_compare = pmac_i2c_do_mask_and_comp,
1413 .delay = pmac_i2c_do_delay,
1416 static void __init pmac_i2c_dev_create(struct device_node *np, int quirks)
1418 DBG("dev_create(%s)\n", np->full_name);
1420 pmf_register_driver(np, &pmac_i2c_pfunc_handlers,
1421 (void *)(long)quirks);
1424 static void __init pmac_i2c_dev_init(struct device_node *np, int quirks)
1426 DBG("dev_create(%s)\n", np->full_name);
1428 pmf_do_functions(np, NULL, 0, PMF_FLAGS_ON_INIT, NULL);
1431 static void pmac_i2c_dev_suspend(struct device_node *np, int quirks)
1433 DBG("dev_suspend(%s)\n", np->full_name);
1434 pmf_do_functions(np, NULL, 0, PMF_FLAGS_ON_SLEEP, NULL);
1437 static void pmac_i2c_dev_resume(struct device_node *np, int quirks)
1439 DBG("dev_resume(%s)\n", np->full_name);
1440 pmf_do_functions(np, NULL, 0, PMF_FLAGS_ON_WAKE, NULL);
1443 void pmac_pfunc_i2c_suspend(void)
1445 pmac_i2c_devscan(pmac_i2c_dev_suspend);
1448 void pmac_pfunc_i2c_resume(void)
1450 pmac_i2c_devscan(pmac_i2c_dev_resume);
1454 * Initialize us: probe all i2c busses on the machine, instantiate
1455 * busses and platform functions as needed.
1457 /* This is non-static as it might be called early by smp code */
1458 int __init pmac_i2c_init(void)
1460 static int i2c_inited;
1466 if (!machine_is(powermac))
1469 /* Probe keywest-i2c busses */
1472 #ifdef CONFIG_ADB_PMU
1473 /* Probe PMU i2c busses */
1477 #ifdef CONFIG_PMAC_SMU
1478 /* Probe SMU i2c busses */
1482 /* Now add plaform functions for some known devices */
1483 pmac_i2c_devscan(pmac_i2c_dev_create);
1487 arch_initcall(pmac_i2c_init);
1489 /* Since pmac_i2c_init can be called too early for the platform device
1490 * registration, we need to do it at a later time. In our case, subsys
1491 * happens to fit well, though I agree it's a bit of a hack...
1493 static int __init pmac_i2c_create_platform_devices(void)
1495 struct pmac_i2c_bus *bus;
1498 /* In the case where we are initialized from smp_init(), we must
1499 * not use the timer (and thus the irq). It's safe from now on
1502 pmac_i2c_force_poll = 0;
1504 /* Create platform devices */
1505 list_for_each_entry(bus, &pmac_i2c_busses, link) {
1507 platform_device_alloc("i2c-powermac", i++);
1508 if (bus->platform_dev == NULL)
1510 bus->platform_dev->dev.platform_data = bus;
1511 platform_device_add(bus->platform_dev);
1514 /* Now call platform "init" functions */
1515 pmac_i2c_devscan(pmac_i2c_dev_init);
1519 subsys_initcall(pmac_i2c_create_platform_devices);