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/config.h>
34 #include <linux/types.h>
35 #include <linux/sched.h>
36 #include <linux/init.h>
37 #include <linux/module.h>
38 #include <linux/adb.h>
39 #include <linux/pmu.h>
40 #include <linux/delay.h>
41 #include <linux/completion.h>
42 #include <linux/platform_device.h>
43 #include <linux/interrupt.h>
44 #include <linux/completion.h>
45 #include <linux/timer.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 semaphore 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_handle_interrupt(struct pmac_i2c_host_kw *host, u8 isr)
238 DBG_LOW("kw_handle_interrupt(%s, isr: %x)\n",
239 __kw_state_names[host->state], isr);
241 if (host->state == state_idle) {
242 printk(KERN_WARNING "low_i2c: Keywest got an out of state"
243 " interrupt, ignoring\n");
244 kw_write_reg(reg_isr, isr);
249 if (host->state != state_stop) {
250 DBG_LOW("KW: Timeout !\n");
254 if (host->state == state_stop) {
255 ack = kw_read_reg(reg_status);
256 if (ack & KW_I2C_STAT_BUSY)
257 kw_write_reg(reg_status, 0);
258 host->state = state_idle;
259 kw_write_reg(reg_ier, 0x00);
261 complete(&host->complete);
266 if (isr & KW_I2C_IRQ_ADDR) {
267 ack = kw_read_reg(reg_status);
268 if (host->state != state_addr) {
269 kw_write_reg(reg_isr, KW_I2C_IRQ_ADDR);
270 WRONG_STATE("KW_I2C_IRQ_ADDR");
274 if ((ack & KW_I2C_STAT_LAST_AAK) == 0) {
275 host->result = -ENODEV;
276 DBG_LOW("KW: NAK on address\n");
277 host->state = state_stop;
280 if (host->len == 0) {
281 kw_write_reg(reg_isr, KW_I2C_IRQ_ADDR);
285 host->state = state_read;
287 kw_write_reg(reg_control,
290 host->state = state_write;
291 kw_write_reg(reg_data, *(host->data++));
295 kw_write_reg(reg_isr, KW_I2C_IRQ_ADDR);
298 if (isr & KW_I2C_IRQ_DATA) {
299 if (host->state == state_read) {
300 *(host->data++) = kw_read_reg(reg_data);
302 kw_write_reg(reg_isr, KW_I2C_IRQ_DATA);
304 host->state = state_stop;
305 else if (host->len == 1)
306 kw_write_reg(reg_control, 0);
307 } else if (host->state == state_write) {
308 ack = kw_read_reg(reg_status);
309 if ((ack & KW_I2C_STAT_LAST_AAK) == 0) {
310 DBG_LOW("KW: nack on data write\n");
313 } else if (host->len) {
314 kw_write_reg(reg_data, *(host->data++));
317 kw_write_reg(reg_control, KW_I2C_CTL_STOP);
318 host->state = state_stop;
321 kw_write_reg(reg_isr, KW_I2C_IRQ_DATA);
323 kw_write_reg(reg_isr, KW_I2C_IRQ_DATA);
324 WRONG_STATE("KW_I2C_IRQ_DATA");
325 if (host->state != state_stop) {
332 if (isr & KW_I2C_IRQ_STOP) {
333 kw_write_reg(reg_isr, KW_I2C_IRQ_STOP);
334 if (host->state != state_stop) {
335 WRONG_STATE("KW_I2C_IRQ_STOP");
338 host->state = state_idle;
340 complete(&host->complete);
343 if (isr & KW_I2C_IRQ_START)
344 kw_write_reg(reg_isr, KW_I2C_IRQ_START);
348 kw_write_reg(reg_control, KW_I2C_CTL_STOP);
349 host->state = state_stop;
353 /* Interrupt handler */
354 static irqreturn_t kw_i2c_irq(int irq, void *dev_id, struct pt_regs *regs)
356 struct pmac_i2c_host_kw *host = dev_id;
359 spin_lock_irqsave(&host->lock, flags);
360 del_timer(&host->timeout_timer);
361 kw_i2c_handle_interrupt(host, kw_read_reg(reg_isr));
362 if (host->state != state_idle) {
363 host->timeout_timer.expires = jiffies + KW_POLL_TIMEOUT;
364 add_timer(&host->timeout_timer);
366 spin_unlock_irqrestore(&host->lock, flags);
370 static void kw_i2c_timeout(unsigned long data)
372 struct pmac_i2c_host_kw *host = (struct pmac_i2c_host_kw *)data;
375 spin_lock_irqsave(&host->lock, flags);
376 kw_i2c_handle_interrupt(host, kw_read_reg(reg_isr));
377 if (host->state != state_idle) {
378 host->timeout_timer.expires = jiffies + KW_POLL_TIMEOUT;
379 add_timer(&host->timeout_timer);
381 spin_unlock_irqrestore(&host->lock, flags);
384 static int kw_i2c_open(struct pmac_i2c_bus *bus)
386 struct pmac_i2c_host_kw *host = bus->hostdata;
391 static void kw_i2c_close(struct pmac_i2c_bus *bus)
393 struct pmac_i2c_host_kw *host = bus->hostdata;
397 static int kw_i2c_xfer(struct pmac_i2c_bus *bus, u8 addrdir, int subsize,
398 u32 subaddr, u8 *data, int len)
400 struct pmac_i2c_host_kw *host = bus->hostdata;
401 u8 mode_reg = host->speed;
402 int use_irq = host->irq != NO_IRQ && !bus->polled;
404 /* Setup mode & subaddress if any */
406 case pmac_i2c_mode_dumb:
408 case pmac_i2c_mode_std:
409 mode_reg |= KW_I2C_MODE_STANDARD;
413 case pmac_i2c_mode_stdsub:
414 mode_reg |= KW_I2C_MODE_STANDARDSUB;
418 case pmac_i2c_mode_combined:
419 mode_reg |= KW_I2C_MODE_COMBINED;
425 /* Setup channel & clear pending irqs */
426 kw_write_reg(reg_isr, kw_read_reg(reg_isr));
427 kw_write_reg(reg_mode, mode_reg | (bus->channel << 4));
428 kw_write_reg(reg_status, 0);
430 /* Set up address and r/w bit, strip possible stale bus number from
433 kw_write_reg(reg_addr, addrdir & 0xff);
435 /* Set up the sub address */
436 if ((mode_reg & KW_I2C_MODE_MODE_MASK) == KW_I2C_MODE_STANDARDSUB
437 || (mode_reg & KW_I2C_MODE_MODE_MASK) == KW_I2C_MODE_COMBINED)
438 kw_write_reg(reg_subaddr, subaddr);
440 /* Prepare for async operations */
443 host->state = state_addr;
445 host->rw = (addrdir & 1);
446 host->polled = bus->polled;
448 /* Enable interrupt if not using polled mode and interrupt is
452 /* Clear completion */
453 INIT_COMPLETION(host->complete);
454 /* Ack stale interrupts */
455 kw_write_reg(reg_isr, kw_read_reg(reg_isr));
457 host->timeout_timer.expires = jiffies + KW_POLL_TIMEOUT;
458 add_timer(&host->timeout_timer);
459 /* Enable emission */
460 kw_write_reg(reg_ier, KW_I2C_IRQ_MASK);
463 /* Start sending address */
464 kw_write_reg(reg_control, KW_I2C_CTL_XADDR);
466 /* Wait for completion */
468 wait_for_completion(&host->complete);
470 while(host->state != state_idle) {
473 u8 isr = kw_i2c_wait_interrupt(host);
474 spin_lock_irqsave(&host->lock, flags);
475 kw_i2c_handle_interrupt(host, isr);
476 spin_unlock_irqrestore(&host->lock, flags);
480 /* Disable emission */
481 kw_write_reg(reg_ier, 0);
486 static struct pmac_i2c_host_kw *__init kw_i2c_host_init(struct device_node *np)
488 struct pmac_i2c_host_kw *host;
489 u32 *psteps, *prate, *addrp, steps;
491 host = kzalloc(sizeof(struct pmac_i2c_host_kw), GFP_KERNEL);
493 printk(KERN_ERR "low_i2c: Can't allocate host for %s\n",
498 /* Apple is kind enough to provide a valid AAPL,address property
499 * on all i2c keywest nodes so far ... we would have to fallback
500 * to macio parsing if that wasn't the case
502 addrp = (u32 *)get_property(np, "AAPL,address", NULL);
504 printk(KERN_ERR "low_i2c: Can't find address for %s\n",
509 init_MUTEX(&host->mutex);
510 init_completion(&host->complete);
511 spin_lock_init(&host->lock);
512 init_timer(&host->timeout_timer);
513 host->timeout_timer.function = kw_i2c_timeout;
514 host->timeout_timer.data = (unsigned long)host;
516 psteps = (u32 *)get_property(np, "AAPL,address-step", NULL);
517 steps = psteps ? (*psteps) : 0x10;
518 for (host->bsteps = 0; (steps & 0x01) == 0; host->bsteps++)
520 /* Select interface rate */
521 host->speed = KW_I2C_MODE_25KHZ;
522 prate = (u32 *)get_property(np, "AAPL,i2c-rate", NULL);
523 if (prate) switch(*prate) {
525 host->speed = KW_I2C_MODE_100KHZ;
528 host->speed = KW_I2C_MODE_50KHZ;
531 host->speed = KW_I2C_MODE_25KHZ;
535 host->irq = np->intrs[0].line;
539 host->base = ioremap((*addrp), 0x1000);
540 if (host->base == NULL) {
541 printk(KERN_ERR "low_i2c: Can't map registers for %s\n",
547 /* Make sure IRA is disabled */
548 kw_write_reg(reg_ier, 0);
550 /* Request chip interrupt */
551 if (request_irq(host->irq, kw_i2c_irq, SA_SHIRQ, "keywest i2c", host))
554 printk(KERN_INFO "KeyWest i2c @0x%08x irq %d %s\n",
555 *addrp, host->irq, np->full_name);
561 static void __init kw_i2c_add(struct pmac_i2c_host_kw *host,
562 struct device_node *controller,
563 struct device_node *busnode,
566 struct pmac_i2c_bus *bus;
568 bus = kzalloc(sizeof(struct pmac_i2c_bus), GFP_KERNEL);
572 bus->controller = of_node_get(controller);
573 bus->busnode = of_node_get(busnode);
574 bus->type = pmac_i2c_bus_keywest;
575 bus->hostdata = host;
576 bus->channel = channel;
577 bus->mode = pmac_i2c_mode_std;
578 bus->open = kw_i2c_open;
579 bus->close = kw_i2c_close;
580 bus->xfer = kw_i2c_xfer;
581 init_MUTEX(&bus->sem);
582 if (controller == busnode)
583 bus->flags = pmac_i2c_multibus;
584 list_add(&bus->link, &pmac_i2c_busses);
586 printk(KERN_INFO " channel %d bus %s\n", channel,
587 (controller == busnode) ? "<multibus>" : busnode->full_name);
590 static void __init kw_i2c_probe(void)
592 struct device_node *np, *child, *parent;
594 /* Probe keywest-i2c busses */
596 (np = of_find_compatible_node(np, "i2c","keywest-i2c")) != NULL;){
597 struct pmac_i2c_host_kw *host;
598 int multibus, chans, i;
600 /* Found one, init a host structure */
601 host = kw_i2c_host_init(np);
605 /* Now check if we have a multibus setup (old style) or if we
606 * have proper bus nodes. Note that the "new" way (proper bus
607 * nodes) might cause us to not create some busses that are
608 * kept hidden in the device-tree. In the future, we might
609 * want to work around that by creating busses without a node
612 child = of_get_next_child(np, NULL);
613 multibus = !child || strcmp(child->name, "i2c-bus");
616 /* For a multibus setup, we get the bus count based on the
620 parent = of_get_parent(np);
623 chans = parent->name[0] == 'u' ? 2 : 1;
624 for (i = 0; i < chans; i++)
625 kw_i2c_add(host, np, np, i);
628 (child = of_get_next_child(np, child)) != NULL;) {
630 (u32 *)get_property(child, "reg", NULL);
633 kw_i2c_add(host, np, child, *reg);
646 #ifdef CONFIG_ADB_PMU
649 * i2c command block to the PMU
662 static void pmu_i2c_complete(struct adb_request *req)
667 static int pmu_i2c_xfer(struct pmac_i2c_bus *bus, u8 addrdir, int subsize,
668 u32 subaddr, u8 *data, int len)
670 struct adb_request *req = bus->hostdata;
671 struct pmu_i2c_hdr *hdr = (struct pmu_i2c_hdr *)&req->data[1];
672 struct completion comp;
673 int read = addrdir & 1;
677 /* For now, limit ourselves to 16 bytes transfers */
681 init_completion(&comp);
683 for (retry = 0; retry < 16; retry++) {
684 memset(req, 0, sizeof(struct adb_request));
685 hdr->bus = bus->channel;
689 case pmac_i2c_mode_std:
692 hdr->address = addrdir;
693 hdr->mode = PMU_I2C_MODE_SIMPLE;
695 case pmac_i2c_mode_stdsub:
696 case pmac_i2c_mode_combined:
699 hdr->address = addrdir & 0xfe;
700 hdr->comb_addr = addrdir;
701 hdr->sub_addr = subaddr;
702 if (bus->mode == pmac_i2c_mode_stdsub)
703 hdr->mode = PMU_I2C_MODE_STDSUB;
705 hdr->mode = PMU_I2C_MODE_COMBINED;
711 INIT_COMPLETION(comp);
712 req->data[0] = PMU_I2C_CMD;
713 req->reply[0] = 0xff;
714 req->nbytes = sizeof(struct pmu_i2c_hdr) + 1;
715 req->done = pmu_i2c_complete;
718 memcpy(hdr->data, data, len);
721 rc = pmu_queue_request(req);
724 wait_for_completion(&comp);
725 if (req->reply[0] == PMU_I2C_STATUS_OK)
729 if (req->reply[0] != PMU_I2C_STATUS_OK)
732 for (retry = 0; retry < 16; retry++) {
733 memset(req, 0, sizeof(struct adb_request));
735 /* I know that looks like a lot, slow as hell, but darwin
736 * does it so let's be on the safe side for now
740 hdr->bus = PMU_I2C_BUS_STATUS;
742 INIT_COMPLETION(comp);
743 req->data[0] = PMU_I2C_CMD;
744 req->reply[0] = 0xff;
746 req->done = pmu_i2c_complete;
748 rc = pmu_queue_request(req);
751 wait_for_completion(&comp);
753 if (req->reply[0] == PMU_I2C_STATUS_OK && !read)
755 if (req->reply[0] == PMU_I2C_STATUS_DATAREAD && read) {
756 int rlen = req->reply_len - 1;
759 printk(KERN_WARNING "low_i2c: PMU returned %d"
760 " bytes, expected %d !\n", rlen, len);
764 memcpy(data, &req->reply[1], len);
771 static void __init pmu_i2c_probe(void)
773 struct pmac_i2c_bus *bus;
774 struct device_node *busnode;
780 /* There might or might not be a "pmu-i2c" node, we use that
781 * or via-pmu itself, whatever we find. I haven't seen a machine
782 * with separate bus nodes, so we assume a multibus setup
784 busnode = of_find_node_by_name(NULL, "pmu-i2c");
786 busnode = of_find_node_by_name(NULL, "via-pmu");
790 printk(KERN_INFO "PMU i2c %s\n", busnode->full_name);
793 * We add bus 1 and 2 only for now, bus 0 is "special"
795 for (channel = 1; channel <= 2; channel++) {
796 sz = sizeof(struct pmac_i2c_bus) + sizeof(struct adb_request);
797 bus = kzalloc(sz, GFP_KERNEL);
801 bus->controller = busnode;
802 bus->busnode = busnode;
803 bus->type = pmac_i2c_bus_pmu;
804 bus->channel = channel;
805 bus->mode = pmac_i2c_mode_std;
806 bus->hostdata = bus + 1;
807 bus->xfer = pmu_i2c_xfer;
808 init_MUTEX(&bus->sem);
809 bus->flags = pmac_i2c_multibus;
810 list_add(&bus->link, &pmac_i2c_busses);
812 printk(KERN_INFO " channel %d bus <multibus>\n", channel);
816 #endif /* CONFIG_ADB_PMU */
825 #ifdef CONFIG_PMAC_SMU
827 static void smu_i2c_complete(struct smu_i2c_cmd *cmd, void *misc)
832 static int smu_i2c_xfer(struct pmac_i2c_bus *bus, u8 addrdir, int subsize,
833 u32 subaddr, u8 *data, int len)
835 struct smu_i2c_cmd *cmd = bus->hostdata;
836 struct completion comp;
837 int read = addrdir & 1;
840 if ((read && len > SMU_I2C_READ_MAX) ||
841 ((!read) && len > SMU_I2C_WRITE_MAX))
844 memset(cmd, 0, sizeof(struct smu_i2c_cmd));
845 cmd->info.bus = bus->channel;
846 cmd->info.devaddr = addrdir;
847 cmd->info.datalen = len;
850 case pmac_i2c_mode_std:
853 cmd->info.type = SMU_I2C_TRANSFER_SIMPLE;
855 case pmac_i2c_mode_stdsub:
856 case pmac_i2c_mode_combined:
857 if (subsize > 3 || subsize < 1)
859 cmd->info.sublen = subsize;
860 /* that's big-endian only but heh ! */
861 memcpy(&cmd->info.subaddr, ((char *)&subaddr) + (4 - subsize),
863 if (bus->mode == pmac_i2c_mode_stdsub)
864 cmd->info.type = SMU_I2C_TRANSFER_STDSUB;
866 cmd->info.type = SMU_I2C_TRANSFER_COMBINED;
872 memcpy(cmd->info.data, data, len);
874 init_completion(&comp);
875 cmd->done = smu_i2c_complete;
877 rc = smu_queue_i2c(cmd);
880 wait_for_completion(&comp);
884 memcpy(data, cmd->info.data, len);
885 return rc < 0 ? rc : 0;
888 static void __init smu_i2c_probe(void)
890 struct device_node *controller, *busnode;
891 struct pmac_i2c_bus *bus;
898 controller = of_find_node_by_name(NULL, "smu-i2c-control");
899 if (controller == NULL)
900 controller = of_find_node_by_name(NULL, "smu");
901 if (controller == NULL)
904 printk(KERN_INFO "SMU i2c %s\n", controller->full_name);
906 /* Look for childs, note that they might not be of the right
907 * type as older device trees mix i2c busses and other thigns
911 (busnode = of_get_next_child(controller, busnode)) != NULL;) {
912 if (strcmp(busnode->type, "i2c") &&
913 strcmp(busnode->type, "i2c-bus"))
915 reg = (u32 *)get_property(busnode, "reg", NULL);
919 sz = sizeof(struct pmac_i2c_bus) + sizeof(struct smu_i2c_cmd);
920 bus = kzalloc(sz, GFP_KERNEL);
924 bus->controller = controller;
925 bus->busnode = of_node_get(busnode);
926 bus->type = pmac_i2c_bus_smu;
928 bus->mode = pmac_i2c_mode_std;
929 bus->hostdata = bus + 1;
930 bus->xfer = smu_i2c_xfer;
931 init_MUTEX(&bus->sem);
933 list_add(&bus->link, &pmac_i2c_busses);
935 printk(KERN_INFO " channel %x bus %s\n",
936 bus->channel, busnode->full_name);
940 #endif /* CONFIG_PMAC_SMU */
949 struct pmac_i2c_bus *pmac_i2c_find_bus(struct device_node *node)
951 struct device_node *p = of_node_get(node);
952 struct device_node *prev = NULL;
953 struct pmac_i2c_bus *bus;
956 list_for_each_entry(bus, &pmac_i2c_busses, link) {
957 if (p == bus->busnode) {
958 if (prev && bus->flags & pmac_i2c_multibus) {
960 reg = (u32 *)get_property(prev, "reg",
964 if (((*reg) >> 8) != bus->channel)
974 p = of_get_parent(p);
978 EXPORT_SYMBOL_GPL(pmac_i2c_find_bus);
980 u8 pmac_i2c_get_dev_addr(struct device_node *device)
982 u32 *reg = (u32 *)get_property(device, "reg", NULL);
987 return (*reg) & 0xff;
989 EXPORT_SYMBOL_GPL(pmac_i2c_get_dev_addr);
991 struct device_node *pmac_i2c_get_controller(struct pmac_i2c_bus *bus)
993 return bus->controller;
995 EXPORT_SYMBOL_GPL(pmac_i2c_get_controller);
997 struct device_node *pmac_i2c_get_bus_node(struct pmac_i2c_bus *bus)
1001 EXPORT_SYMBOL_GPL(pmac_i2c_get_bus_node);
1003 int pmac_i2c_get_type(struct pmac_i2c_bus *bus)
1007 EXPORT_SYMBOL_GPL(pmac_i2c_get_type);
1009 int pmac_i2c_get_flags(struct pmac_i2c_bus *bus)
1013 EXPORT_SYMBOL_GPL(pmac_i2c_get_flags);
1015 int pmac_i2c_get_channel(struct pmac_i2c_bus *bus)
1017 return bus->channel;
1019 EXPORT_SYMBOL_GPL(pmac_i2c_get_channel);
1022 void pmac_i2c_attach_adapter(struct pmac_i2c_bus *bus,
1023 struct i2c_adapter *adapter)
1025 WARN_ON(bus->adapter != NULL);
1026 bus->adapter = adapter;
1028 EXPORT_SYMBOL_GPL(pmac_i2c_attach_adapter);
1030 void pmac_i2c_detach_adapter(struct pmac_i2c_bus *bus,
1031 struct i2c_adapter *adapter)
1033 WARN_ON(bus->adapter != adapter);
1034 bus->adapter = NULL;
1036 EXPORT_SYMBOL_GPL(pmac_i2c_detach_adapter);
1038 struct i2c_adapter *pmac_i2c_get_adapter(struct pmac_i2c_bus *bus)
1040 return bus->adapter;
1042 EXPORT_SYMBOL_GPL(pmac_i2c_get_adapter);
1044 struct pmac_i2c_bus *pmac_i2c_adapter_to_bus(struct i2c_adapter *adapter)
1046 struct pmac_i2c_bus *bus;
1048 list_for_each_entry(bus, &pmac_i2c_busses, link)
1049 if (bus->adapter == adapter)
1053 EXPORT_SYMBOL_GPL(pmac_i2c_adapter_to_bus);
1055 int pmac_i2c_match_adapter(struct device_node *dev, struct i2c_adapter *adapter)
1057 struct pmac_i2c_bus *bus = pmac_i2c_find_bus(dev);
1061 return (bus->adapter == adapter);
1063 EXPORT_SYMBOL_GPL(pmac_i2c_match_adapter);
1065 int pmac_low_i2c_lock(struct device_node *np)
1067 struct pmac_i2c_bus *bus, *found = NULL;
1069 list_for_each_entry(bus, &pmac_i2c_busses, link) {
1070 if (np == bus->controller) {
1077 return pmac_i2c_open(bus, 0);
1079 EXPORT_SYMBOL_GPL(pmac_low_i2c_lock);
1081 int pmac_low_i2c_unlock(struct device_node *np)
1083 struct pmac_i2c_bus *bus, *found = NULL;
1085 list_for_each_entry(bus, &pmac_i2c_busses, link) {
1086 if (np == bus->controller) {
1093 pmac_i2c_close(bus);
1096 EXPORT_SYMBOL_GPL(pmac_low_i2c_unlock);
1099 int pmac_i2c_open(struct pmac_i2c_bus *bus, int polled)
1104 bus->polled = polled || pmac_i2c_force_poll;
1106 bus->mode = pmac_i2c_mode_std;
1107 if (bus->open && (rc = bus->open(bus)) != 0) {
1114 EXPORT_SYMBOL_GPL(pmac_i2c_open);
1116 void pmac_i2c_close(struct pmac_i2c_bus *bus)
1118 WARN_ON(!bus->opened);
1124 EXPORT_SYMBOL_GPL(pmac_i2c_close);
1126 int pmac_i2c_setmode(struct pmac_i2c_bus *bus, int mode)
1128 WARN_ON(!bus->opened);
1130 /* Report me if you see the error below as there might be a new
1131 * "combined4" mode that I need to implement for the SMU bus
1133 if (mode < pmac_i2c_mode_dumb || mode > pmac_i2c_mode_combined) {
1134 printk(KERN_ERR "low_i2c: Invalid mode %d requested on"
1135 " bus %s !\n", mode, bus->busnode->full_name);
1142 EXPORT_SYMBOL_GPL(pmac_i2c_setmode);
1144 int pmac_i2c_xfer(struct pmac_i2c_bus *bus, u8 addrdir, int subsize,
1145 u32 subaddr, u8 *data, int len)
1149 WARN_ON(!bus->opened);
1151 DBG("xfer() chan=%d, addrdir=0x%x, mode=%d, subsize=%d, subaddr=0x%x,"
1152 " %d bytes, bus %s\n", bus->channel, addrdir, bus->mode, subsize,
1153 subaddr, len, bus->busnode->full_name);
1155 rc = bus->xfer(bus, addrdir, subsize, subaddr, data, len);
1159 DBG("xfer error %d\n", rc);
1163 EXPORT_SYMBOL_GPL(pmac_i2c_xfer);
1165 /* some quirks for platform function decoding */
1167 pmac_i2c_quirk_invmask = 0x00000001u,
1170 static void pmac_i2c_devscan(void (*callback)(struct device_node *dev,
1173 struct pmac_i2c_bus *bus;
1174 struct device_node *np;
1175 static struct whitelist_ent {
1180 /* XXX Study device-tree's & apple drivers are get the quirks
1183 { "i2c-hwclock", NULL, pmac_i2c_quirk_invmask },
1184 { "i2c-cpu-voltage", NULL, 0},
1185 { "temp-monitor", NULL, 0 },
1186 { "supply-monitor", NULL, 0 },
1190 /* Only some devices need to have platform functions instanciated
1191 * here. For now, we have a table. Others, like 9554 i2c GPIOs used
1192 * on Xserve, if we ever do a driver for them, will use their own
1193 * platform function instance
1195 list_for_each_entry(bus, &pmac_i2c_busses, link) {
1197 (np = of_get_next_child(bus->busnode, np)) != NULL;) {
1198 struct whitelist_ent *p;
1199 /* If multibus, check if device is on that bus */
1200 if (bus->flags & pmac_i2c_multibus)
1201 if (bus != pmac_i2c_find_bus(np))
1203 for (p = whitelist; p->name != NULL; p++) {
1204 if (strcmp(np->name, p->name))
1206 if (p->compatible &&
1207 !device_is_compatible(np, p->compatible))
1209 callback(np, p->quirks);
1216 #define MAX_I2C_DATA 64
1218 struct pmac_i2c_pf_inst
1220 struct pmac_i2c_bus *bus;
1222 u8 buffer[MAX_I2C_DATA];
1223 u8 scratch[MAX_I2C_DATA];
1228 static void* pmac_i2c_do_begin(struct pmf_function *func, struct pmf_args *args)
1230 struct pmac_i2c_pf_inst *inst;
1231 struct pmac_i2c_bus *bus;
1233 bus = pmac_i2c_find_bus(func->node);
1235 printk(KERN_ERR "low_i2c: Can't find bus for %s (pfunc)\n",
1236 func->node->full_name);
1239 if (pmac_i2c_open(bus, 0)) {
1240 printk(KERN_ERR "low_i2c: Can't open i2c bus for %s (pfunc)\n",
1241 func->node->full_name);
1245 /* XXX might need GFP_ATOMIC when called during the suspend process,
1246 * but then, there are already lots of issues with suspending when
1247 * near OOM that need to be resolved, the allocator itself should
1248 * probably make GFP_NOIO implicit during suspend
1250 inst = kzalloc(sizeof(struct pmac_i2c_pf_inst), GFP_KERNEL);
1252 pmac_i2c_close(bus);
1256 inst->addr = pmac_i2c_get_dev_addr(func->node);
1257 inst->quirks = (int)(long)func->driver_data;
1261 static void pmac_i2c_do_end(struct pmf_function *func, void *instdata)
1263 struct pmac_i2c_pf_inst *inst = instdata;
1267 pmac_i2c_close(inst->bus);
1272 static int pmac_i2c_do_read(PMF_STD_ARGS, u32 len)
1274 struct pmac_i2c_pf_inst *inst = instdata;
1277 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_read, 0, 0,
1281 static int pmac_i2c_do_write(PMF_STD_ARGS, u32 len, const u8 *data)
1283 struct pmac_i2c_pf_inst *inst = instdata;
1285 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_write, 0, 0,
1289 /* This function is used to do the masking & OR'ing for the "rmw" type
1290 * callbacks. Ze should apply the mask and OR in the values in the
1291 * buffer before writing back. The problem is that it seems that
1292 * various darwin drivers implement the mask/or differently, thus
1293 * we need to check the quirks first
1295 static void pmac_i2c_do_apply_rmw(struct pmac_i2c_pf_inst *inst,
1296 u32 len, const u8 *mask, const u8 *val)
1300 if (inst->quirks & pmac_i2c_quirk_invmask) {
1301 for (i = 0; i < len; i ++)
1302 inst->scratch[i] = (inst->buffer[i] & mask[i]) | val[i];
1304 for (i = 0; i < len; i ++)
1305 inst->scratch[i] = (inst->buffer[i] & ~mask[i])
1306 | (val[i] & mask[i]);
1310 static int pmac_i2c_do_rmw(PMF_STD_ARGS, u32 masklen, u32 valuelen,
1311 u32 totallen, const u8 *maskdata,
1312 const u8 *valuedata)
1314 struct pmac_i2c_pf_inst *inst = instdata;
1316 if (masklen > inst->bytes || valuelen > inst->bytes ||
1317 totallen > inst->bytes || valuelen > masklen)
1320 pmac_i2c_do_apply_rmw(inst, masklen, maskdata, valuedata);
1322 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_write, 0, 0,
1323 inst->scratch, totallen);
1326 static int pmac_i2c_do_read_sub(PMF_STD_ARGS, u8 subaddr, u32 len)
1328 struct pmac_i2c_pf_inst *inst = instdata;
1331 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_read, 1, subaddr,
1335 static int pmac_i2c_do_write_sub(PMF_STD_ARGS, u8 subaddr, u32 len,
1338 struct pmac_i2c_pf_inst *inst = instdata;
1340 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_write, 1,
1341 subaddr, (u8 *)data, len);
1344 static int pmac_i2c_do_set_mode(PMF_STD_ARGS, int mode)
1346 struct pmac_i2c_pf_inst *inst = instdata;
1348 return pmac_i2c_setmode(inst->bus, mode);
1351 static int pmac_i2c_do_rmw_sub(PMF_STD_ARGS, u8 subaddr, u32 masklen,
1352 u32 valuelen, u32 totallen, const u8 *maskdata,
1353 const u8 *valuedata)
1355 struct pmac_i2c_pf_inst *inst = instdata;
1357 if (masklen > inst->bytes || valuelen > inst->bytes ||
1358 totallen > inst->bytes || valuelen > masklen)
1361 pmac_i2c_do_apply_rmw(inst, masklen, maskdata, valuedata);
1363 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_write, 1,
1364 subaddr, inst->scratch, totallen);
1367 static int pmac_i2c_do_mask_and_comp(PMF_STD_ARGS, u32 len,
1369 const u8 *valuedata)
1371 struct pmac_i2c_pf_inst *inst = instdata;
1374 /* Get return value pointer, it's assumed to be a u32 */
1375 if (!args || !args->count || !args->u[0].p)
1379 if (len > inst->bytes)
1382 for (i = 0, match = 1; match && i < len; i ++)
1383 if ((inst->buffer[i] & maskdata[i]) != valuedata[i])
1385 *args->u[0].p = match;
1389 static int pmac_i2c_do_delay(PMF_STD_ARGS, u32 duration)
1391 msleep((duration + 999) / 1000);
1396 static struct pmf_handlers pmac_i2c_pfunc_handlers = {
1397 .begin = pmac_i2c_do_begin,
1398 .end = pmac_i2c_do_end,
1399 .read_i2c = pmac_i2c_do_read,
1400 .write_i2c = pmac_i2c_do_write,
1401 .rmw_i2c = pmac_i2c_do_rmw,
1402 .read_i2c_sub = pmac_i2c_do_read_sub,
1403 .write_i2c_sub = pmac_i2c_do_write_sub,
1404 .rmw_i2c_sub = pmac_i2c_do_rmw_sub,
1405 .set_i2c_mode = pmac_i2c_do_set_mode,
1406 .mask_and_compare = pmac_i2c_do_mask_and_comp,
1407 .delay = pmac_i2c_do_delay,
1410 static void __init pmac_i2c_dev_create(struct device_node *np, int quirks)
1412 DBG("dev_create(%s)\n", np->full_name);
1414 pmf_register_driver(np, &pmac_i2c_pfunc_handlers,
1415 (void *)(long)quirks);
1418 static void __init pmac_i2c_dev_init(struct device_node *np, int quirks)
1420 DBG("dev_create(%s)\n", np->full_name);
1422 pmf_do_functions(np, NULL, 0, PMF_FLAGS_ON_INIT, NULL);
1425 static void pmac_i2c_dev_suspend(struct device_node *np, int quirks)
1427 DBG("dev_suspend(%s)\n", np->full_name);
1428 pmf_do_functions(np, NULL, 0, PMF_FLAGS_ON_SLEEP, NULL);
1431 static void pmac_i2c_dev_resume(struct device_node *np, int quirks)
1433 DBG("dev_resume(%s)\n", np->full_name);
1434 pmf_do_functions(np, NULL, 0, PMF_FLAGS_ON_WAKE, NULL);
1437 void pmac_pfunc_i2c_suspend(void)
1439 pmac_i2c_devscan(pmac_i2c_dev_suspend);
1442 void pmac_pfunc_i2c_resume(void)
1444 pmac_i2c_devscan(pmac_i2c_dev_resume);
1448 * Initialize us: probe all i2c busses on the machine, instantiate
1449 * busses and platform functions as needed.
1451 /* This is non-static as it might be called early by smp code */
1452 int __init pmac_i2c_init(void)
1454 static int i2c_inited;
1460 /* Probe keywest-i2c busses */
1463 #ifdef CONFIG_ADB_PMU
1464 /* Probe PMU i2c busses */
1468 #ifdef CONFIG_PMAC_SMU
1469 /* Probe SMU i2c busses */
1473 /* Now add plaform functions for some known devices */
1474 pmac_i2c_devscan(pmac_i2c_dev_create);
1478 arch_initcall(pmac_i2c_init);
1480 /* Since pmac_i2c_init can be called too early for the platform device
1481 * registration, we need to do it at a later time. In our case, subsys
1482 * happens to fit well, though I agree it's a bit of a hack...
1484 static int __init pmac_i2c_create_platform_devices(void)
1486 struct pmac_i2c_bus *bus;
1489 /* In the case where we are initialized from smp_init(), we must
1490 * not use the timer (and thus the irq). It's safe from now on
1493 pmac_i2c_force_poll = 0;
1495 /* Create platform devices */
1496 list_for_each_entry(bus, &pmac_i2c_busses, link) {
1498 platform_device_alloc("i2c-powermac", i++);
1499 if (bus->platform_dev == NULL)
1501 bus->platform_dev->dev.platform_data = bus;
1502 platform_device_add(bus->platform_dev);
1505 /* Now call platform "init" functions */
1506 pmac_i2c_devscan(pmac_i2c_dev_init);
1510 subsys_initcall(pmac_i2c_create_platform_devices);