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/timer.h>
44 #include <linux/mutex.h>
45 #include <asm/keylargo.h>
46 #include <asm/uninorth.h>
49 #include <asm/machdep.h>
51 #include <asm/pmac_pfunc.h>
52 #include <asm/pmac_low_i2c.h>
55 #define DBG(x...) do {\
56 printk(KERN_DEBUG "low_i2c:" x); \
63 #define DBG_LOW(x...) do {\
64 printk(KERN_DEBUG "low_i2c:" x); \
71 static int pmac_i2c_force_poll = 1;
74 * A bus structure. Each bus in the system has such a structure associated.
78 struct list_head link;
79 struct device_node *controller;
80 struct device_node *busnode;
83 struct i2c_adapter *adapter;
85 int channel; /* some hosts have multiple */
86 int mode; /* current mode */
89 int polled; /* open mode */
90 struct platform_device *platform_dev;
93 int (*open)(struct pmac_i2c_bus *bus);
94 void (*close)(struct pmac_i2c_bus *bus);
95 int (*xfer)(struct pmac_i2c_bus *bus, u8 addrdir, int subsize,
96 u32 subaddr, u8 *data, int len);
99 static LIST_HEAD(pmac_i2c_busses);
102 * Keywest implementation
105 struct pmac_i2c_host_kw
107 struct mutex mutex; /* Access mutex for use by
109 void __iomem *base; /* register base address */
110 int bsteps; /* register stepping */
111 int speed; /* speed */
119 struct completion complete;
121 struct timer_list timeout_timer;
124 /* Register indices */
136 /* The Tumbler audio equalizer can be really slow sometimes */
137 #define KW_POLL_TIMEOUT (2*HZ)
140 #define KW_I2C_MODE_100KHZ 0x00
141 #define KW_I2C_MODE_50KHZ 0x01
142 #define KW_I2C_MODE_25KHZ 0x02
143 #define KW_I2C_MODE_DUMB 0x00
144 #define KW_I2C_MODE_STANDARD 0x04
145 #define KW_I2C_MODE_STANDARDSUB 0x08
146 #define KW_I2C_MODE_COMBINED 0x0C
147 #define KW_I2C_MODE_MODE_MASK 0x0C
148 #define KW_I2C_MODE_CHAN_MASK 0xF0
150 /* Control register */
151 #define KW_I2C_CTL_AAK 0x01
152 #define KW_I2C_CTL_XADDR 0x02
153 #define KW_I2C_CTL_STOP 0x04
154 #define KW_I2C_CTL_START 0x08
156 /* Status register */
157 #define KW_I2C_STAT_BUSY 0x01
158 #define KW_I2C_STAT_LAST_AAK 0x02
159 #define KW_I2C_STAT_LAST_RW 0x04
160 #define KW_I2C_STAT_SDA 0x08
161 #define KW_I2C_STAT_SCL 0x10
163 /* IER & ISR registers */
164 #define KW_I2C_IRQ_DATA 0x01
165 #define KW_I2C_IRQ_ADDR 0x02
166 #define KW_I2C_IRQ_STOP 0x04
167 #define KW_I2C_IRQ_START 0x08
168 #define KW_I2C_IRQ_MASK 0x0F
170 /* State machine states */
180 #define WRONG_STATE(name) do {\
181 printk(KERN_DEBUG "KW: wrong state. Got %s, state: %s " \
183 name, __kw_state_names[host->state], isr); \
186 static const char *__kw_state_names[] = {
195 static inline u8 __kw_read_reg(struct pmac_i2c_host_kw *host, reg_t reg)
197 return readb(host->base + (((unsigned int)reg) << host->bsteps));
200 static inline void __kw_write_reg(struct pmac_i2c_host_kw *host,
203 writeb(val, host->base + (((unsigned)reg) << host->bsteps));
204 (void)__kw_read_reg(host, reg_subaddr);
207 #define kw_write_reg(reg, val) __kw_write_reg(host, reg, val)
208 #define kw_read_reg(reg) __kw_read_reg(host, reg)
210 static u8 kw_i2c_wait_interrupt(struct pmac_i2c_host_kw *host)
215 for (i = 0; i < 1000; i++) {
216 isr = kw_read_reg(reg_isr) & KW_I2C_IRQ_MASK;
220 /* This code is used with the timebase frozen, we cannot rely
221 * on udelay nor schedule when in polled mode !
222 * For now, just use a bogus loop....
225 for (j = 1; j < 100000; j++)
233 static void kw_i2c_do_stop(struct pmac_i2c_host_kw *host, int result)
235 kw_write_reg(reg_control, KW_I2C_CTL_STOP);
236 host->state = state_stop;
237 host->result = result;
241 static void kw_i2c_handle_interrupt(struct pmac_i2c_host_kw *host, u8 isr)
245 DBG_LOW("kw_handle_interrupt(%s, isr: %x)\n",
246 __kw_state_names[host->state], isr);
248 if (host->state == state_idle) {
249 printk(KERN_WARNING "low_i2c: Keywest got an out of state"
250 " interrupt, ignoring\n");
251 kw_write_reg(reg_isr, isr);
256 printk(KERN_WARNING "low_i2c: Timeout in i2c transfer"
258 if (host->state != state_stop) {
259 kw_i2c_do_stop(host, -EIO);
262 ack = kw_read_reg(reg_status);
263 if (ack & KW_I2C_STAT_BUSY)
264 kw_write_reg(reg_status, 0);
265 host->state = state_idle;
266 kw_write_reg(reg_ier, 0x00);
268 complete(&host->complete);
272 if (isr & KW_I2C_IRQ_ADDR) {
273 ack = kw_read_reg(reg_status);
274 if (host->state != state_addr) {
275 WRONG_STATE("KW_I2C_IRQ_ADDR");
276 kw_i2c_do_stop(host, -EIO);
278 if ((ack & KW_I2C_STAT_LAST_AAK) == 0) {
279 host->result = -ENXIO;
280 host->state = state_stop;
281 DBG_LOW("KW: NAK on address\n");
284 kw_i2c_do_stop(host, 0);
286 host->state = state_read;
288 kw_write_reg(reg_control,
291 host->state = state_write;
292 kw_write_reg(reg_data, *(host->data++));
296 kw_write_reg(reg_isr, KW_I2C_IRQ_ADDR);
299 if (isr & KW_I2C_IRQ_DATA) {
300 if (host->state == state_read) {
301 *(host->data++) = kw_read_reg(reg_data);
303 kw_write_reg(reg_isr, KW_I2C_IRQ_DATA);
305 host->state = state_stop;
306 else if (host->len == 1)
307 kw_write_reg(reg_control, 0);
308 } else if (host->state == state_write) {
309 ack = kw_read_reg(reg_status);
310 if ((ack & KW_I2C_STAT_LAST_AAK) == 0) {
311 DBG_LOW("KW: nack on data write\n");
312 host->result = -EFBIG;
313 host->state = state_stop;
314 } else if (host->len) {
315 kw_write_reg(reg_data, *(host->data++));
318 kw_i2c_do_stop(host, 0);
320 WRONG_STATE("KW_I2C_IRQ_DATA");
321 if (host->state != state_stop)
322 kw_i2c_do_stop(host, -EIO);
324 kw_write_reg(reg_isr, KW_I2C_IRQ_DATA);
327 if (isr & KW_I2C_IRQ_STOP) {
328 kw_write_reg(reg_isr, KW_I2C_IRQ_STOP);
329 if (host->state != state_stop) {
330 WRONG_STATE("KW_I2C_IRQ_STOP");
333 host->state = state_idle;
335 complete(&host->complete);
338 /* Below should only happen in manual mode which we don't use ... */
339 if (isr & KW_I2C_IRQ_START)
340 kw_write_reg(reg_isr, KW_I2C_IRQ_START);
344 /* Interrupt handler */
345 static irqreturn_t kw_i2c_irq(int irq, void *dev_id)
347 struct pmac_i2c_host_kw *host = dev_id;
350 spin_lock_irqsave(&host->lock, flags);
351 del_timer(&host->timeout_timer);
352 kw_i2c_handle_interrupt(host, kw_read_reg(reg_isr));
353 if (host->state != state_idle) {
354 host->timeout_timer.expires = jiffies + KW_POLL_TIMEOUT;
355 add_timer(&host->timeout_timer);
357 spin_unlock_irqrestore(&host->lock, flags);
361 static void kw_i2c_timeout(unsigned long data)
363 struct pmac_i2c_host_kw *host = (struct pmac_i2c_host_kw *)data;
366 spin_lock_irqsave(&host->lock, flags);
367 kw_i2c_handle_interrupt(host, kw_read_reg(reg_isr));
368 if (host->state != state_idle) {
369 host->timeout_timer.expires = jiffies + KW_POLL_TIMEOUT;
370 add_timer(&host->timeout_timer);
372 spin_unlock_irqrestore(&host->lock, flags);
375 static int kw_i2c_open(struct pmac_i2c_bus *bus)
377 struct pmac_i2c_host_kw *host = bus->hostdata;
378 mutex_lock(&host->mutex);
382 static void kw_i2c_close(struct pmac_i2c_bus *bus)
384 struct pmac_i2c_host_kw *host = bus->hostdata;
385 mutex_unlock(&host->mutex);
388 static int kw_i2c_xfer(struct pmac_i2c_bus *bus, u8 addrdir, int subsize,
389 u32 subaddr, u8 *data, int len)
391 struct pmac_i2c_host_kw *host = bus->hostdata;
392 u8 mode_reg = host->speed;
393 int use_irq = host->irq != NO_IRQ && !bus->polled;
395 /* Setup mode & subaddress if any */
397 case pmac_i2c_mode_dumb:
399 case pmac_i2c_mode_std:
400 mode_reg |= KW_I2C_MODE_STANDARD;
404 case pmac_i2c_mode_stdsub:
405 mode_reg |= KW_I2C_MODE_STANDARDSUB;
409 case pmac_i2c_mode_combined:
410 mode_reg |= KW_I2C_MODE_COMBINED;
416 /* Setup channel & clear pending irqs */
417 kw_write_reg(reg_isr, kw_read_reg(reg_isr));
418 kw_write_reg(reg_mode, mode_reg | (bus->channel << 4));
419 kw_write_reg(reg_status, 0);
421 /* Set up address and r/w bit, strip possible stale bus number from
424 kw_write_reg(reg_addr, addrdir & 0xff);
426 /* Set up the sub address */
427 if ((mode_reg & KW_I2C_MODE_MODE_MASK) == KW_I2C_MODE_STANDARDSUB
428 || (mode_reg & KW_I2C_MODE_MODE_MASK) == KW_I2C_MODE_COMBINED)
429 kw_write_reg(reg_subaddr, subaddr);
431 /* Prepare for async operations */
434 host->state = state_addr;
436 host->rw = (addrdir & 1);
437 host->polled = bus->polled;
439 /* Enable interrupt if not using polled mode and interrupt is
443 /* Clear completion */
444 INIT_COMPLETION(host->complete);
445 /* Ack stale interrupts */
446 kw_write_reg(reg_isr, kw_read_reg(reg_isr));
448 host->timeout_timer.expires = jiffies + KW_POLL_TIMEOUT;
449 add_timer(&host->timeout_timer);
450 /* Enable emission */
451 kw_write_reg(reg_ier, KW_I2C_IRQ_MASK);
454 /* Start sending address */
455 kw_write_reg(reg_control, KW_I2C_CTL_XADDR);
457 /* Wait for completion */
459 wait_for_completion(&host->complete);
461 while(host->state != state_idle) {
464 u8 isr = kw_i2c_wait_interrupt(host);
465 spin_lock_irqsave(&host->lock, flags);
466 kw_i2c_handle_interrupt(host, isr);
467 spin_unlock_irqrestore(&host->lock, flags);
471 /* Disable emission */
472 kw_write_reg(reg_ier, 0);
477 static struct pmac_i2c_host_kw *__init kw_i2c_host_init(struct device_node *np)
479 struct pmac_i2c_host_kw *host;
480 const u32 *psteps, *prate, *addrp;
483 host = kzalloc(sizeof(struct pmac_i2c_host_kw), GFP_KERNEL);
485 printk(KERN_ERR "low_i2c: Can't allocate host for %s\n",
490 /* Apple is kind enough to provide a valid AAPL,address property
491 * on all i2c keywest nodes so far ... we would have to fallback
492 * to macio parsing if that wasn't the case
494 addrp = of_get_property(np, "AAPL,address", NULL);
496 printk(KERN_ERR "low_i2c: Can't find address for %s\n",
501 mutex_init(&host->mutex);
502 init_completion(&host->complete);
503 spin_lock_init(&host->lock);
504 init_timer(&host->timeout_timer);
505 host->timeout_timer.function = kw_i2c_timeout;
506 host->timeout_timer.data = (unsigned long)host;
508 psteps = of_get_property(np, "AAPL,address-step", NULL);
509 steps = psteps ? (*psteps) : 0x10;
510 for (host->bsteps = 0; (steps & 0x01) == 0; host->bsteps++)
512 /* Select interface rate */
513 host->speed = KW_I2C_MODE_25KHZ;
514 prate = of_get_property(np, "AAPL,i2c-rate", NULL);
515 if (prate) switch(*prate) {
517 host->speed = KW_I2C_MODE_100KHZ;
520 host->speed = KW_I2C_MODE_50KHZ;
523 host->speed = KW_I2C_MODE_25KHZ;
526 host->irq = irq_of_parse_and_map(np, 0);
527 if (host->irq == NO_IRQ)
529 "low_i2c: Failed to map interrupt for %s\n",
532 host->base = ioremap((*addrp), 0x1000);
533 if (host->base == NULL) {
534 printk(KERN_ERR "low_i2c: Can't map registers for %s\n",
540 /* Make sure IRQ is disabled */
541 kw_write_reg(reg_ier, 0);
543 /* Request chip interrupt. We set IRQF_TIMER because we don't
544 * want that interrupt disabled between the 2 passes of driver
545 * suspend or we'll have issues running the pfuncs
547 if (request_irq(host->irq, kw_i2c_irq, IRQF_TIMER, "keywest i2c", host))
550 printk(KERN_INFO "KeyWest i2c @0x%08x irq %d %s\n",
551 *addrp, host->irq, np->full_name);
557 static void __init kw_i2c_add(struct pmac_i2c_host_kw *host,
558 struct device_node *controller,
559 struct device_node *busnode,
562 struct pmac_i2c_bus *bus;
564 bus = kzalloc(sizeof(struct pmac_i2c_bus), GFP_KERNEL);
568 bus->controller = of_node_get(controller);
569 bus->busnode = of_node_get(busnode);
570 bus->type = pmac_i2c_bus_keywest;
571 bus->hostdata = host;
572 bus->channel = channel;
573 bus->mode = pmac_i2c_mode_std;
574 bus->open = kw_i2c_open;
575 bus->close = kw_i2c_close;
576 bus->xfer = kw_i2c_xfer;
577 mutex_init(&bus->mutex);
578 if (controller == busnode)
579 bus->flags = pmac_i2c_multibus;
580 list_add(&bus->link, &pmac_i2c_busses);
582 printk(KERN_INFO " channel %d bus %s\n", channel,
583 (controller == busnode) ? "<multibus>" : busnode->full_name);
586 static void __init kw_i2c_probe(void)
588 struct device_node *np, *child, *parent;
590 /* Probe keywest-i2c busses */
591 for_each_compatible_node(np, "i2c","keywest-i2c") {
592 struct pmac_i2c_host_kw *host;
593 int multibus, chans, i;
595 /* Found one, init a host structure */
596 host = kw_i2c_host_init(np);
600 /* Now check if we have a multibus setup (old style) or if we
601 * have proper bus nodes. Note that the "new" way (proper bus
602 * nodes) might cause us to not create some busses that are
603 * kept hidden in the device-tree. In the future, we might
604 * want to work around that by creating busses without a node
607 child = of_get_next_child(np, NULL);
608 multibus = !child || strcmp(child->name, "i2c-bus");
611 /* For a multibus setup, we get the bus count based on the
615 parent = of_get_parent(np);
618 chans = parent->name[0] == 'u' ? 2 : 1;
619 for (i = 0; i < chans; i++)
620 kw_i2c_add(host, np, np, i);
623 (child = of_get_next_child(np, child)) != NULL;) {
624 const u32 *reg = of_get_property(child,
628 kw_i2c_add(host, np, child, *reg);
641 #ifdef CONFIG_ADB_PMU
644 * i2c command block to the PMU
657 static void pmu_i2c_complete(struct adb_request *req)
662 static int pmu_i2c_xfer(struct pmac_i2c_bus *bus, u8 addrdir, int subsize,
663 u32 subaddr, u8 *data, int len)
665 struct adb_request *req = bus->hostdata;
666 struct pmu_i2c_hdr *hdr = (struct pmu_i2c_hdr *)&req->data[1];
667 struct completion comp;
668 int read = addrdir & 1;
672 /* For now, limit ourselves to 16 bytes transfers */
676 init_completion(&comp);
678 for (retry = 0; retry < 16; retry++) {
679 memset(req, 0, sizeof(struct adb_request));
680 hdr->bus = bus->channel;
684 case pmac_i2c_mode_std:
687 hdr->address = addrdir;
688 hdr->mode = PMU_I2C_MODE_SIMPLE;
690 case pmac_i2c_mode_stdsub:
691 case pmac_i2c_mode_combined:
694 hdr->address = addrdir & 0xfe;
695 hdr->comb_addr = addrdir;
696 hdr->sub_addr = subaddr;
697 if (bus->mode == pmac_i2c_mode_stdsub)
698 hdr->mode = PMU_I2C_MODE_STDSUB;
700 hdr->mode = PMU_I2C_MODE_COMBINED;
706 INIT_COMPLETION(comp);
707 req->data[0] = PMU_I2C_CMD;
708 req->reply[0] = 0xff;
709 req->nbytes = sizeof(struct pmu_i2c_hdr) + 1;
710 req->done = pmu_i2c_complete;
713 memcpy(hdr->data, data, len);
716 rc = pmu_queue_request(req);
719 wait_for_completion(&comp);
720 if (req->reply[0] == PMU_I2C_STATUS_OK)
724 if (req->reply[0] != PMU_I2C_STATUS_OK)
727 for (retry = 0; retry < 16; retry++) {
728 memset(req, 0, sizeof(struct adb_request));
730 /* I know that looks like a lot, slow as hell, but darwin
731 * does it so let's be on the safe side for now
735 hdr->bus = PMU_I2C_BUS_STATUS;
737 INIT_COMPLETION(comp);
738 req->data[0] = PMU_I2C_CMD;
739 req->reply[0] = 0xff;
741 req->done = pmu_i2c_complete;
743 rc = pmu_queue_request(req);
746 wait_for_completion(&comp);
748 if (req->reply[0] == PMU_I2C_STATUS_OK && !read)
750 if (req->reply[0] == PMU_I2C_STATUS_DATAREAD && read) {
751 int rlen = req->reply_len - 1;
754 printk(KERN_WARNING "low_i2c: PMU returned %d"
755 " bytes, expected %d !\n", rlen, len);
759 memcpy(data, &req->reply[1], len);
766 static void __init pmu_i2c_probe(void)
768 struct pmac_i2c_bus *bus;
769 struct device_node *busnode;
775 /* There might or might not be a "pmu-i2c" node, we use that
776 * or via-pmu itself, whatever we find. I haven't seen a machine
777 * with separate bus nodes, so we assume a multibus setup
779 busnode = of_find_node_by_name(NULL, "pmu-i2c");
781 busnode = of_find_node_by_name(NULL, "via-pmu");
785 printk(KERN_INFO "PMU i2c %s\n", busnode->full_name);
788 * We add bus 1 and 2 only for now, bus 0 is "special"
790 for (channel = 1; channel <= 2; channel++) {
791 sz = sizeof(struct pmac_i2c_bus) + sizeof(struct adb_request);
792 bus = kzalloc(sz, GFP_KERNEL);
796 bus->controller = busnode;
797 bus->busnode = busnode;
798 bus->type = pmac_i2c_bus_pmu;
799 bus->channel = channel;
800 bus->mode = pmac_i2c_mode_std;
801 bus->hostdata = bus + 1;
802 bus->xfer = pmu_i2c_xfer;
803 mutex_init(&bus->mutex);
804 bus->flags = pmac_i2c_multibus;
805 list_add(&bus->link, &pmac_i2c_busses);
807 printk(KERN_INFO " channel %d bus <multibus>\n", channel);
811 #endif /* CONFIG_ADB_PMU */
820 #ifdef CONFIG_PMAC_SMU
822 static void smu_i2c_complete(struct smu_i2c_cmd *cmd, void *misc)
827 static int smu_i2c_xfer(struct pmac_i2c_bus *bus, u8 addrdir, int subsize,
828 u32 subaddr, u8 *data, int len)
830 struct smu_i2c_cmd *cmd = bus->hostdata;
831 struct completion comp;
832 int read = addrdir & 1;
835 if ((read && len > SMU_I2C_READ_MAX) ||
836 ((!read) && len > SMU_I2C_WRITE_MAX))
839 memset(cmd, 0, sizeof(struct smu_i2c_cmd));
840 cmd->info.bus = bus->channel;
841 cmd->info.devaddr = addrdir;
842 cmd->info.datalen = len;
845 case pmac_i2c_mode_std:
848 cmd->info.type = SMU_I2C_TRANSFER_SIMPLE;
850 case pmac_i2c_mode_stdsub:
851 case pmac_i2c_mode_combined:
852 if (subsize > 3 || subsize < 1)
854 cmd->info.sublen = subsize;
855 /* that's big-endian only but heh ! */
856 memcpy(&cmd->info.subaddr, ((char *)&subaddr) + (4 - subsize),
858 if (bus->mode == pmac_i2c_mode_stdsub)
859 cmd->info.type = SMU_I2C_TRANSFER_STDSUB;
861 cmd->info.type = SMU_I2C_TRANSFER_COMBINED;
867 memcpy(cmd->info.data, data, len);
869 init_completion(&comp);
870 cmd->done = smu_i2c_complete;
872 rc = smu_queue_i2c(cmd);
875 wait_for_completion(&comp);
879 memcpy(data, cmd->info.data, len);
880 return rc < 0 ? rc : 0;
883 static void __init smu_i2c_probe(void)
885 struct device_node *controller, *busnode;
886 struct pmac_i2c_bus *bus;
893 controller = of_find_node_by_name(NULL, "smu-i2c-control");
894 if (controller == NULL)
895 controller = of_find_node_by_name(NULL, "smu");
896 if (controller == NULL)
899 printk(KERN_INFO "SMU i2c %s\n", controller->full_name);
901 /* Look for childs, note that they might not be of the right
902 * type as older device trees mix i2c busses and other thigns
906 (busnode = of_get_next_child(controller, busnode)) != NULL;) {
907 if (strcmp(busnode->type, "i2c") &&
908 strcmp(busnode->type, "i2c-bus"))
910 reg = of_get_property(busnode, "reg", NULL);
914 sz = sizeof(struct pmac_i2c_bus) + sizeof(struct smu_i2c_cmd);
915 bus = kzalloc(sz, GFP_KERNEL);
919 bus->controller = controller;
920 bus->busnode = of_node_get(busnode);
921 bus->type = pmac_i2c_bus_smu;
923 bus->mode = pmac_i2c_mode_std;
924 bus->hostdata = bus + 1;
925 bus->xfer = smu_i2c_xfer;
926 mutex_init(&bus->mutex);
928 list_add(&bus->link, &pmac_i2c_busses);
930 printk(KERN_INFO " channel %x bus %s\n",
931 bus->channel, busnode->full_name);
935 #endif /* CONFIG_PMAC_SMU */
944 struct pmac_i2c_bus *pmac_i2c_find_bus(struct device_node *node)
946 struct device_node *p = of_node_get(node);
947 struct device_node *prev = NULL;
948 struct pmac_i2c_bus *bus;
951 list_for_each_entry(bus, &pmac_i2c_busses, link) {
952 if (p == bus->busnode) {
953 if (prev && bus->flags & pmac_i2c_multibus) {
955 reg = of_get_property(prev, "reg",
959 if (((*reg) >> 8) != bus->channel)
969 p = of_get_parent(p);
973 EXPORT_SYMBOL_GPL(pmac_i2c_find_bus);
975 u8 pmac_i2c_get_dev_addr(struct device_node *device)
977 const u32 *reg = of_get_property(device, "reg", NULL);
982 return (*reg) & 0xff;
984 EXPORT_SYMBOL_GPL(pmac_i2c_get_dev_addr);
986 struct device_node *pmac_i2c_get_controller(struct pmac_i2c_bus *bus)
988 return bus->controller;
990 EXPORT_SYMBOL_GPL(pmac_i2c_get_controller);
992 struct device_node *pmac_i2c_get_bus_node(struct pmac_i2c_bus *bus)
996 EXPORT_SYMBOL_GPL(pmac_i2c_get_bus_node);
998 int pmac_i2c_get_type(struct pmac_i2c_bus *bus)
1002 EXPORT_SYMBOL_GPL(pmac_i2c_get_type);
1004 int pmac_i2c_get_flags(struct pmac_i2c_bus *bus)
1008 EXPORT_SYMBOL_GPL(pmac_i2c_get_flags);
1010 int pmac_i2c_get_channel(struct pmac_i2c_bus *bus)
1012 return bus->channel;
1014 EXPORT_SYMBOL_GPL(pmac_i2c_get_channel);
1017 void pmac_i2c_attach_adapter(struct pmac_i2c_bus *bus,
1018 struct i2c_adapter *adapter)
1020 WARN_ON(bus->adapter != NULL);
1021 bus->adapter = adapter;
1023 EXPORT_SYMBOL_GPL(pmac_i2c_attach_adapter);
1025 void pmac_i2c_detach_adapter(struct pmac_i2c_bus *bus,
1026 struct i2c_adapter *adapter)
1028 WARN_ON(bus->adapter != adapter);
1029 bus->adapter = NULL;
1031 EXPORT_SYMBOL_GPL(pmac_i2c_detach_adapter);
1033 struct i2c_adapter *pmac_i2c_get_adapter(struct pmac_i2c_bus *bus)
1035 return bus->adapter;
1037 EXPORT_SYMBOL_GPL(pmac_i2c_get_adapter);
1039 struct pmac_i2c_bus *pmac_i2c_adapter_to_bus(struct i2c_adapter *adapter)
1041 struct pmac_i2c_bus *bus;
1043 list_for_each_entry(bus, &pmac_i2c_busses, link)
1044 if (bus->adapter == adapter)
1048 EXPORT_SYMBOL_GPL(pmac_i2c_adapter_to_bus);
1050 int pmac_i2c_match_adapter(struct device_node *dev, struct i2c_adapter *adapter)
1052 struct pmac_i2c_bus *bus = pmac_i2c_find_bus(dev);
1056 return (bus->adapter == adapter);
1058 EXPORT_SYMBOL_GPL(pmac_i2c_match_adapter);
1060 int pmac_low_i2c_lock(struct device_node *np)
1062 struct pmac_i2c_bus *bus, *found = NULL;
1064 list_for_each_entry(bus, &pmac_i2c_busses, link) {
1065 if (np == bus->controller) {
1072 return pmac_i2c_open(bus, 0);
1074 EXPORT_SYMBOL_GPL(pmac_low_i2c_lock);
1076 int pmac_low_i2c_unlock(struct device_node *np)
1078 struct pmac_i2c_bus *bus, *found = NULL;
1080 list_for_each_entry(bus, &pmac_i2c_busses, link) {
1081 if (np == bus->controller) {
1088 pmac_i2c_close(bus);
1091 EXPORT_SYMBOL_GPL(pmac_low_i2c_unlock);
1094 int pmac_i2c_open(struct pmac_i2c_bus *bus, int polled)
1098 mutex_lock(&bus->mutex);
1099 bus->polled = polled || pmac_i2c_force_poll;
1101 bus->mode = pmac_i2c_mode_std;
1102 if (bus->open && (rc = bus->open(bus)) != 0) {
1104 mutex_unlock(&bus->mutex);
1109 EXPORT_SYMBOL_GPL(pmac_i2c_open);
1111 void pmac_i2c_close(struct pmac_i2c_bus *bus)
1113 WARN_ON(!bus->opened);
1117 mutex_unlock(&bus->mutex);
1119 EXPORT_SYMBOL_GPL(pmac_i2c_close);
1121 int pmac_i2c_setmode(struct pmac_i2c_bus *bus, int mode)
1123 WARN_ON(!bus->opened);
1125 /* Report me if you see the error below as there might be a new
1126 * "combined4" mode that I need to implement for the SMU bus
1128 if (mode < pmac_i2c_mode_dumb || mode > pmac_i2c_mode_combined) {
1129 printk(KERN_ERR "low_i2c: Invalid mode %d requested on"
1130 " bus %s !\n", mode, bus->busnode->full_name);
1137 EXPORT_SYMBOL_GPL(pmac_i2c_setmode);
1139 int pmac_i2c_xfer(struct pmac_i2c_bus *bus, u8 addrdir, int subsize,
1140 u32 subaddr, u8 *data, int len)
1144 WARN_ON(!bus->opened);
1146 DBG("xfer() chan=%d, addrdir=0x%x, mode=%d, subsize=%d, subaddr=0x%x,"
1147 " %d bytes, bus %s\n", bus->channel, addrdir, bus->mode, subsize,
1148 subaddr, len, bus->busnode->full_name);
1150 rc = bus->xfer(bus, addrdir, subsize, subaddr, data, len);
1154 DBG("xfer error %d\n", rc);
1158 EXPORT_SYMBOL_GPL(pmac_i2c_xfer);
1160 /* some quirks for platform function decoding */
1162 pmac_i2c_quirk_invmask = 0x00000001u,
1163 pmac_i2c_quirk_skip = 0x00000002u,
1166 static void pmac_i2c_devscan(void (*callback)(struct device_node *dev,
1169 struct pmac_i2c_bus *bus;
1170 struct device_node *np;
1171 static struct whitelist_ent {
1176 /* XXX Study device-tree's & apple drivers are get the quirks
1179 /* Workaround: It seems that running the clockspreading
1180 * properties on the eMac will cause lockups during boot.
1181 * The machine seems to work fine without that. So for now,
1182 * let's make sure i2c-hwclock doesn't match about "imic"
1183 * clocks and we'll figure out if we really need to do
1184 * something special about those later.
1186 { "i2c-hwclock", "imic5002", pmac_i2c_quirk_skip },
1187 { "i2c-hwclock", "imic5003", pmac_i2c_quirk_skip },
1188 { "i2c-hwclock", NULL, pmac_i2c_quirk_invmask },
1189 { "i2c-cpu-voltage", NULL, 0},
1190 { "temp-monitor", NULL, 0 },
1191 { "supply-monitor", NULL, 0 },
1195 /* Only some devices need to have platform functions instanciated
1196 * here. For now, we have a table. Others, like 9554 i2c GPIOs used
1197 * on Xserve, if we ever do a driver for them, will use their own
1198 * platform function instance
1200 list_for_each_entry(bus, &pmac_i2c_busses, link) {
1202 (np = of_get_next_child(bus->busnode, np)) != NULL;) {
1203 struct whitelist_ent *p;
1204 /* If multibus, check if device is on that bus */
1205 if (bus->flags & pmac_i2c_multibus)
1206 if (bus != pmac_i2c_find_bus(np))
1208 for (p = whitelist; p->name != NULL; p++) {
1209 if (strcmp(np->name, p->name))
1211 if (p->compatible &&
1212 !of_device_is_compatible(np, p->compatible))
1214 if (p->quirks & pmac_i2c_quirk_skip)
1216 callback(np, p->quirks);
1223 #define MAX_I2C_DATA 64
1225 struct pmac_i2c_pf_inst
1227 struct pmac_i2c_bus *bus;
1229 u8 buffer[MAX_I2C_DATA];
1230 u8 scratch[MAX_I2C_DATA];
1235 static void* pmac_i2c_do_begin(struct pmf_function *func, struct pmf_args *args)
1237 struct pmac_i2c_pf_inst *inst;
1238 struct pmac_i2c_bus *bus;
1240 bus = pmac_i2c_find_bus(func->node);
1242 printk(KERN_ERR "low_i2c: Can't find bus for %s (pfunc)\n",
1243 func->node->full_name);
1246 if (pmac_i2c_open(bus, 0)) {
1247 printk(KERN_ERR "low_i2c: Can't open i2c bus for %s (pfunc)\n",
1248 func->node->full_name);
1252 /* XXX might need GFP_ATOMIC when called during the suspend process,
1253 * but then, there are already lots of issues with suspending when
1254 * near OOM that need to be resolved, the allocator itself should
1255 * probably make GFP_NOIO implicit during suspend
1257 inst = kzalloc(sizeof(struct pmac_i2c_pf_inst), GFP_KERNEL);
1259 pmac_i2c_close(bus);
1263 inst->addr = pmac_i2c_get_dev_addr(func->node);
1264 inst->quirks = (int)(long)func->driver_data;
1268 static void pmac_i2c_do_end(struct pmf_function *func, void *instdata)
1270 struct pmac_i2c_pf_inst *inst = instdata;
1274 pmac_i2c_close(inst->bus);
1279 static int pmac_i2c_do_read(PMF_STD_ARGS, u32 len)
1281 struct pmac_i2c_pf_inst *inst = instdata;
1284 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_read, 0, 0,
1288 static int pmac_i2c_do_write(PMF_STD_ARGS, u32 len, const u8 *data)
1290 struct pmac_i2c_pf_inst *inst = instdata;
1292 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_write, 0, 0,
1296 /* This function is used to do the masking & OR'ing for the "rmw" type
1297 * callbacks. Ze should apply the mask and OR in the values in the
1298 * buffer before writing back. The problem is that it seems that
1299 * various darwin drivers implement the mask/or differently, thus
1300 * we need to check the quirks first
1302 static void pmac_i2c_do_apply_rmw(struct pmac_i2c_pf_inst *inst,
1303 u32 len, const u8 *mask, const u8 *val)
1307 if (inst->quirks & pmac_i2c_quirk_invmask) {
1308 for (i = 0; i < len; i ++)
1309 inst->scratch[i] = (inst->buffer[i] & mask[i]) | val[i];
1311 for (i = 0; i < len; i ++)
1312 inst->scratch[i] = (inst->buffer[i] & ~mask[i])
1313 | (val[i] & mask[i]);
1317 static int pmac_i2c_do_rmw(PMF_STD_ARGS, u32 masklen, u32 valuelen,
1318 u32 totallen, const u8 *maskdata,
1319 const u8 *valuedata)
1321 struct pmac_i2c_pf_inst *inst = instdata;
1323 if (masklen > inst->bytes || valuelen > inst->bytes ||
1324 totallen > inst->bytes || valuelen > masklen)
1327 pmac_i2c_do_apply_rmw(inst, masklen, maskdata, valuedata);
1329 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_write, 0, 0,
1330 inst->scratch, totallen);
1333 static int pmac_i2c_do_read_sub(PMF_STD_ARGS, u8 subaddr, u32 len)
1335 struct pmac_i2c_pf_inst *inst = instdata;
1338 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_read, 1, subaddr,
1342 static int pmac_i2c_do_write_sub(PMF_STD_ARGS, u8 subaddr, u32 len,
1345 struct pmac_i2c_pf_inst *inst = instdata;
1347 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_write, 1,
1348 subaddr, (u8 *)data, len);
1351 static int pmac_i2c_do_set_mode(PMF_STD_ARGS, int mode)
1353 struct pmac_i2c_pf_inst *inst = instdata;
1355 return pmac_i2c_setmode(inst->bus, mode);
1358 static int pmac_i2c_do_rmw_sub(PMF_STD_ARGS, u8 subaddr, u32 masklen,
1359 u32 valuelen, u32 totallen, const u8 *maskdata,
1360 const u8 *valuedata)
1362 struct pmac_i2c_pf_inst *inst = instdata;
1364 if (masklen > inst->bytes || valuelen > inst->bytes ||
1365 totallen > inst->bytes || valuelen > masklen)
1368 pmac_i2c_do_apply_rmw(inst, masklen, maskdata, valuedata);
1370 return pmac_i2c_xfer(inst->bus, inst->addr | pmac_i2c_write, 1,
1371 subaddr, inst->scratch, totallen);
1374 static int pmac_i2c_do_mask_and_comp(PMF_STD_ARGS, u32 len,
1376 const u8 *valuedata)
1378 struct pmac_i2c_pf_inst *inst = instdata;
1381 /* Get return value pointer, it's assumed to be a u32 */
1382 if (!args || !args->count || !args->u[0].p)
1386 if (len > inst->bytes)
1389 for (i = 0, match = 1; match && i < len; i ++)
1390 if ((inst->buffer[i] & maskdata[i]) != valuedata[i])
1392 *args->u[0].p = match;
1396 static int pmac_i2c_do_delay(PMF_STD_ARGS, u32 duration)
1398 msleep((duration + 999) / 1000);
1403 static struct pmf_handlers pmac_i2c_pfunc_handlers = {
1404 .begin = pmac_i2c_do_begin,
1405 .end = pmac_i2c_do_end,
1406 .read_i2c = pmac_i2c_do_read,
1407 .write_i2c = pmac_i2c_do_write,
1408 .rmw_i2c = pmac_i2c_do_rmw,
1409 .read_i2c_sub = pmac_i2c_do_read_sub,
1410 .write_i2c_sub = pmac_i2c_do_write_sub,
1411 .rmw_i2c_sub = pmac_i2c_do_rmw_sub,
1412 .set_i2c_mode = pmac_i2c_do_set_mode,
1413 .mask_and_compare = pmac_i2c_do_mask_and_comp,
1414 .delay = pmac_i2c_do_delay,
1417 static void __init pmac_i2c_dev_create(struct device_node *np, int quirks)
1419 DBG("dev_create(%s)\n", np->full_name);
1421 pmf_register_driver(np, &pmac_i2c_pfunc_handlers,
1422 (void *)(long)quirks);
1425 static void __init pmac_i2c_dev_init(struct device_node *np, int quirks)
1427 DBG("dev_create(%s)\n", np->full_name);
1429 pmf_do_functions(np, NULL, 0, PMF_FLAGS_ON_INIT, NULL);
1432 static void pmac_i2c_dev_suspend(struct device_node *np, int quirks)
1434 DBG("dev_suspend(%s)\n", np->full_name);
1435 pmf_do_functions(np, NULL, 0, PMF_FLAGS_ON_SLEEP, NULL);
1438 static void pmac_i2c_dev_resume(struct device_node *np, int quirks)
1440 DBG("dev_resume(%s)\n", np->full_name);
1441 pmf_do_functions(np, NULL, 0, PMF_FLAGS_ON_WAKE, NULL);
1444 void pmac_pfunc_i2c_suspend(void)
1446 pmac_i2c_devscan(pmac_i2c_dev_suspend);
1449 void pmac_pfunc_i2c_resume(void)
1451 pmac_i2c_devscan(pmac_i2c_dev_resume);
1455 * Initialize us: probe all i2c busses on the machine, instantiate
1456 * busses and platform functions as needed.
1458 /* This is non-static as it might be called early by smp code */
1459 int __init pmac_i2c_init(void)
1461 static int i2c_inited;
1467 /* Probe keywest-i2c busses */
1470 #ifdef CONFIG_ADB_PMU
1471 /* Probe PMU i2c busses */
1475 #ifdef CONFIG_PMAC_SMU
1476 /* Probe SMU i2c busses */
1480 /* Now add plaform functions for some known devices */
1481 pmac_i2c_devscan(pmac_i2c_dev_create);
1485 machine_arch_initcall(powermac, pmac_i2c_init);
1487 /* Since pmac_i2c_init can be called too early for the platform device
1488 * registration, we need to do it at a later time. In our case, subsys
1489 * happens to fit well, though I agree it's a bit of a hack...
1491 static int __init pmac_i2c_create_platform_devices(void)
1493 struct pmac_i2c_bus *bus;
1496 /* In the case where we are initialized from smp_init(), we must
1497 * not use the timer (and thus the irq). It's safe from now on
1500 pmac_i2c_force_poll = 0;
1502 /* Create platform devices */
1503 list_for_each_entry(bus, &pmac_i2c_busses, link) {
1505 platform_device_alloc("i2c-powermac", i++);
1506 if (bus->platform_dev == NULL)
1508 bus->platform_dev->dev.platform_data = bus;
1509 platform_device_add(bus->platform_dev);
1512 /* Now call platform "init" functions */
1513 pmac_i2c_devscan(pmac_i2c_dev_init);
1517 machine_subsys_initcall(powermac, pmac_i2c_create_platform_devices);