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 */
544 if (request_irq(host
->irq
, kw_i2c_irq
, 0, "keywest i2c", host
))
547 printk(KERN_INFO
"KeyWest i2c @0x%08x irq %d %s\n",
548 *addrp
, host
->irq
, np
->full_name
);
554 static void __init
kw_i2c_add(struct pmac_i2c_host_kw
*host
,
555 struct device_node
*controller
,
556 struct device_node
*busnode
,
559 struct pmac_i2c_bus
*bus
;
561 bus
= kzalloc(sizeof(struct pmac_i2c_bus
), GFP_KERNEL
);
565 bus
->controller
= of_node_get(controller
);
566 bus
->busnode
= of_node_get(busnode
);
567 bus
->type
= pmac_i2c_bus_keywest
;
568 bus
->hostdata
= host
;
569 bus
->channel
= channel
;
570 bus
->mode
= pmac_i2c_mode_std
;
571 bus
->open
= kw_i2c_open
;
572 bus
->close
= kw_i2c_close
;
573 bus
->xfer
= kw_i2c_xfer
;
574 mutex_init(&bus
->mutex
);
575 if (controller
== busnode
)
576 bus
->flags
= pmac_i2c_multibus
;
577 list_add(&bus
->link
, &pmac_i2c_busses
);
579 printk(KERN_INFO
" channel %d bus %s\n", channel
,
580 (controller
== busnode
) ? "<multibus>" : busnode
->full_name
);
583 static void __init
kw_i2c_probe(void)
585 struct device_node
*np
, *child
, *parent
;
587 /* Probe keywest-i2c busses */
588 for_each_compatible_node(np
, "i2c","keywest-i2c") {
589 struct pmac_i2c_host_kw
*host
;
590 int multibus
, chans
, i
;
592 /* Found one, init a host structure */
593 host
= kw_i2c_host_init(np
);
597 /* Now check if we have a multibus setup (old style) or if we
598 * have proper bus nodes. Note that the "new" way (proper bus
599 * nodes) might cause us to not create some busses that are
600 * kept hidden in the device-tree. In the future, we might
601 * want to work around that by creating busses without a node
604 child
= of_get_next_child(np
, NULL
);
605 multibus
= !child
|| strcmp(child
->name
, "i2c-bus");
608 /* For a multibus setup, we get the bus count based on the
612 parent
= of_get_parent(np
);
615 chans
= parent
->name
[0] == 'u' ? 2 : 1;
616 for (i
= 0; i
< chans
; i
++)
617 kw_i2c_add(host
, np
, np
, i
);
620 (child
= of_get_next_child(np
, child
)) != NULL
;) {
621 const u32
*reg
= of_get_property(child
,
625 kw_i2c_add(host
, np
, child
, *reg
);
638 #ifdef CONFIG_ADB_PMU
641 * i2c command block to the PMU
654 static void pmu_i2c_complete(struct adb_request
*req
)
659 static int pmu_i2c_xfer(struct pmac_i2c_bus
*bus
, u8 addrdir
, int subsize
,
660 u32 subaddr
, u8
*data
, int len
)
662 struct adb_request
*req
= bus
->hostdata
;
663 struct pmu_i2c_hdr
*hdr
= (struct pmu_i2c_hdr
*)&req
->data
[1];
664 struct completion comp
;
665 int read
= addrdir
& 1;
669 /* For now, limit ourselves to 16 bytes transfers */
673 init_completion(&comp
);
675 for (retry
= 0; retry
< 16; retry
++) {
676 memset(req
, 0, sizeof(struct adb_request
));
677 hdr
->bus
= bus
->channel
;
681 case pmac_i2c_mode_std
:
684 hdr
->address
= addrdir
;
685 hdr
->mode
= PMU_I2C_MODE_SIMPLE
;
687 case pmac_i2c_mode_stdsub
:
688 case pmac_i2c_mode_combined
:
691 hdr
->address
= addrdir
& 0xfe;
692 hdr
->comb_addr
= addrdir
;
693 hdr
->sub_addr
= subaddr
;
694 if (bus
->mode
== pmac_i2c_mode_stdsub
)
695 hdr
->mode
= PMU_I2C_MODE_STDSUB
;
697 hdr
->mode
= PMU_I2C_MODE_COMBINED
;
703 INIT_COMPLETION(comp
);
704 req
->data
[0] = PMU_I2C_CMD
;
705 req
->reply
[0] = 0xff;
706 req
->nbytes
= sizeof(struct pmu_i2c_hdr
) + 1;
707 req
->done
= pmu_i2c_complete
;
710 memcpy(hdr
->data
, data
, len
);
713 rc
= pmu_queue_request(req
);
716 wait_for_completion(&comp
);
717 if (req
->reply
[0] == PMU_I2C_STATUS_OK
)
721 if (req
->reply
[0] != PMU_I2C_STATUS_OK
)
724 for (retry
= 0; retry
< 16; retry
++) {
725 memset(req
, 0, sizeof(struct adb_request
));
727 /* I know that looks like a lot, slow as hell, but darwin
728 * does it so let's be on the safe side for now
732 hdr
->bus
= PMU_I2C_BUS_STATUS
;
734 INIT_COMPLETION(comp
);
735 req
->data
[0] = PMU_I2C_CMD
;
736 req
->reply
[0] = 0xff;
738 req
->done
= pmu_i2c_complete
;
740 rc
= pmu_queue_request(req
);
743 wait_for_completion(&comp
);
745 if (req
->reply
[0] == PMU_I2C_STATUS_OK
&& !read
)
747 if (req
->reply
[0] == PMU_I2C_STATUS_DATAREAD
&& read
) {
748 int rlen
= req
->reply_len
- 1;
751 printk(KERN_WARNING
"low_i2c: PMU returned %d"
752 " bytes, expected %d !\n", rlen
, len
);
756 memcpy(data
, &req
->reply
[1], len
);
763 static void __init
pmu_i2c_probe(void)
765 struct pmac_i2c_bus
*bus
;
766 struct device_node
*busnode
;
772 /* There might or might not be a "pmu-i2c" node, we use that
773 * or via-pmu itself, whatever we find. I haven't seen a machine
774 * with separate bus nodes, so we assume a multibus setup
776 busnode
= of_find_node_by_name(NULL
, "pmu-i2c");
778 busnode
= of_find_node_by_name(NULL
, "via-pmu");
782 printk(KERN_INFO
"PMU i2c %s\n", busnode
->full_name
);
785 * We add bus 1 and 2 only for now, bus 0 is "special"
787 for (channel
= 1; channel
<= 2; channel
++) {
788 sz
= sizeof(struct pmac_i2c_bus
) + sizeof(struct adb_request
);
789 bus
= kzalloc(sz
, GFP_KERNEL
);
793 bus
->controller
= busnode
;
794 bus
->busnode
= busnode
;
795 bus
->type
= pmac_i2c_bus_pmu
;
796 bus
->channel
= channel
;
797 bus
->mode
= pmac_i2c_mode_std
;
798 bus
->hostdata
= bus
+ 1;
799 bus
->xfer
= pmu_i2c_xfer
;
800 mutex_init(&bus
->mutex
);
801 bus
->flags
= pmac_i2c_multibus
;
802 list_add(&bus
->link
, &pmac_i2c_busses
);
804 printk(KERN_INFO
" channel %d bus <multibus>\n", channel
);
808 #endif /* CONFIG_ADB_PMU */
817 #ifdef CONFIG_PMAC_SMU
819 static void smu_i2c_complete(struct smu_i2c_cmd
*cmd
, void *misc
)
824 static int smu_i2c_xfer(struct pmac_i2c_bus
*bus
, u8 addrdir
, int subsize
,
825 u32 subaddr
, u8
*data
, int len
)
827 struct smu_i2c_cmd
*cmd
= bus
->hostdata
;
828 struct completion comp
;
829 int read
= addrdir
& 1;
832 if ((read
&& len
> SMU_I2C_READ_MAX
) ||
833 ((!read
) && len
> SMU_I2C_WRITE_MAX
))
836 memset(cmd
, 0, sizeof(struct smu_i2c_cmd
));
837 cmd
->info
.bus
= bus
->channel
;
838 cmd
->info
.devaddr
= addrdir
;
839 cmd
->info
.datalen
= len
;
842 case pmac_i2c_mode_std
:
845 cmd
->info
.type
= SMU_I2C_TRANSFER_SIMPLE
;
847 case pmac_i2c_mode_stdsub
:
848 case pmac_i2c_mode_combined
:
849 if (subsize
> 3 || subsize
< 1)
851 cmd
->info
.sublen
= subsize
;
852 /* that's big-endian only but heh ! */
853 memcpy(&cmd
->info
.subaddr
, ((char *)&subaddr
) + (4 - subsize
),
855 if (bus
->mode
== pmac_i2c_mode_stdsub
)
856 cmd
->info
.type
= SMU_I2C_TRANSFER_STDSUB
;
858 cmd
->info
.type
= SMU_I2C_TRANSFER_COMBINED
;
864 memcpy(cmd
->info
.data
, data
, len
);
866 init_completion(&comp
);
867 cmd
->done
= smu_i2c_complete
;
869 rc
= smu_queue_i2c(cmd
);
872 wait_for_completion(&comp
);
876 memcpy(data
, cmd
->info
.data
, len
);
877 return rc
< 0 ? rc
: 0;
880 static void __init
smu_i2c_probe(void)
882 struct device_node
*controller
, *busnode
;
883 struct pmac_i2c_bus
*bus
;
890 controller
= of_find_node_by_name(NULL
, "smu-i2c-control");
891 if (controller
== NULL
)
892 controller
= of_find_node_by_name(NULL
, "smu");
893 if (controller
== NULL
)
896 printk(KERN_INFO
"SMU i2c %s\n", controller
->full_name
);
898 /* Look for childs, note that they might not be of the right
899 * type as older device trees mix i2c busses and other thigns
903 (busnode
= of_get_next_child(controller
, busnode
)) != NULL
;) {
904 if (strcmp(busnode
->type
, "i2c") &&
905 strcmp(busnode
->type
, "i2c-bus"))
907 reg
= of_get_property(busnode
, "reg", NULL
);
911 sz
= sizeof(struct pmac_i2c_bus
) + sizeof(struct smu_i2c_cmd
);
912 bus
= kzalloc(sz
, GFP_KERNEL
);
916 bus
->controller
= controller
;
917 bus
->busnode
= of_node_get(busnode
);
918 bus
->type
= pmac_i2c_bus_smu
;
920 bus
->mode
= pmac_i2c_mode_std
;
921 bus
->hostdata
= bus
+ 1;
922 bus
->xfer
= smu_i2c_xfer
;
923 mutex_init(&bus
->mutex
);
925 list_add(&bus
->link
, &pmac_i2c_busses
);
927 printk(KERN_INFO
" channel %x bus %s\n",
928 bus
->channel
, busnode
->full_name
);
932 #endif /* CONFIG_PMAC_SMU */
941 struct pmac_i2c_bus
*pmac_i2c_find_bus(struct device_node
*node
)
943 struct device_node
*p
= of_node_get(node
);
944 struct device_node
*prev
= NULL
;
945 struct pmac_i2c_bus
*bus
;
948 list_for_each_entry(bus
, &pmac_i2c_busses
, link
) {
949 if (p
== bus
->busnode
) {
950 if (prev
&& bus
->flags
& pmac_i2c_multibus
) {
952 reg
= of_get_property(prev
, "reg",
956 if (((*reg
) >> 8) != bus
->channel
)
966 p
= of_get_parent(p
);
970 EXPORT_SYMBOL_GPL(pmac_i2c_find_bus
);
972 u8
pmac_i2c_get_dev_addr(struct device_node
*device
)
974 const u32
*reg
= of_get_property(device
, "reg", NULL
);
979 return (*reg
) & 0xff;
981 EXPORT_SYMBOL_GPL(pmac_i2c_get_dev_addr
);
983 struct device_node
*pmac_i2c_get_controller(struct pmac_i2c_bus
*bus
)
985 return bus
->controller
;
987 EXPORT_SYMBOL_GPL(pmac_i2c_get_controller
);
989 struct device_node
*pmac_i2c_get_bus_node(struct pmac_i2c_bus
*bus
)
993 EXPORT_SYMBOL_GPL(pmac_i2c_get_bus_node
);
995 int pmac_i2c_get_type(struct pmac_i2c_bus
*bus
)
999 EXPORT_SYMBOL_GPL(pmac_i2c_get_type
);
1001 int pmac_i2c_get_flags(struct pmac_i2c_bus
*bus
)
1005 EXPORT_SYMBOL_GPL(pmac_i2c_get_flags
);
1007 int pmac_i2c_get_channel(struct pmac_i2c_bus
*bus
)
1009 return bus
->channel
;
1011 EXPORT_SYMBOL_GPL(pmac_i2c_get_channel
);
1014 void pmac_i2c_attach_adapter(struct pmac_i2c_bus
*bus
,
1015 struct i2c_adapter
*adapter
)
1017 WARN_ON(bus
->adapter
!= NULL
);
1018 bus
->adapter
= adapter
;
1020 EXPORT_SYMBOL_GPL(pmac_i2c_attach_adapter
);
1022 void pmac_i2c_detach_adapter(struct pmac_i2c_bus
*bus
,
1023 struct i2c_adapter
*adapter
)
1025 WARN_ON(bus
->adapter
!= adapter
);
1026 bus
->adapter
= NULL
;
1028 EXPORT_SYMBOL_GPL(pmac_i2c_detach_adapter
);
1030 struct i2c_adapter
*pmac_i2c_get_adapter(struct pmac_i2c_bus
*bus
)
1032 return bus
->adapter
;
1034 EXPORT_SYMBOL_GPL(pmac_i2c_get_adapter
);
1036 struct pmac_i2c_bus
*pmac_i2c_adapter_to_bus(struct i2c_adapter
*adapter
)
1038 struct pmac_i2c_bus
*bus
;
1040 list_for_each_entry(bus
, &pmac_i2c_busses
, link
)
1041 if (bus
->adapter
== adapter
)
1045 EXPORT_SYMBOL_GPL(pmac_i2c_adapter_to_bus
);
1047 int pmac_i2c_match_adapter(struct device_node
*dev
, struct i2c_adapter
*adapter
)
1049 struct pmac_i2c_bus
*bus
= pmac_i2c_find_bus(dev
);
1053 return (bus
->adapter
== adapter
);
1055 EXPORT_SYMBOL_GPL(pmac_i2c_match_adapter
);
1057 int pmac_low_i2c_lock(struct device_node
*np
)
1059 struct pmac_i2c_bus
*bus
, *found
= NULL
;
1061 list_for_each_entry(bus
, &pmac_i2c_busses
, link
) {
1062 if (np
== bus
->controller
) {
1069 return pmac_i2c_open(bus
, 0);
1071 EXPORT_SYMBOL_GPL(pmac_low_i2c_lock
);
1073 int pmac_low_i2c_unlock(struct device_node
*np
)
1075 struct pmac_i2c_bus
*bus
, *found
= NULL
;
1077 list_for_each_entry(bus
, &pmac_i2c_busses
, link
) {
1078 if (np
== bus
->controller
) {
1085 pmac_i2c_close(bus
);
1088 EXPORT_SYMBOL_GPL(pmac_low_i2c_unlock
);
1091 int pmac_i2c_open(struct pmac_i2c_bus
*bus
, int polled
)
1095 mutex_lock(&bus
->mutex
);
1096 bus
->polled
= polled
|| pmac_i2c_force_poll
;
1098 bus
->mode
= pmac_i2c_mode_std
;
1099 if (bus
->open
&& (rc
= bus
->open(bus
)) != 0) {
1101 mutex_unlock(&bus
->mutex
);
1106 EXPORT_SYMBOL_GPL(pmac_i2c_open
);
1108 void pmac_i2c_close(struct pmac_i2c_bus
*bus
)
1110 WARN_ON(!bus
->opened
);
1114 mutex_unlock(&bus
->mutex
);
1116 EXPORT_SYMBOL_GPL(pmac_i2c_close
);
1118 int pmac_i2c_setmode(struct pmac_i2c_bus
*bus
, int mode
)
1120 WARN_ON(!bus
->opened
);
1122 /* Report me if you see the error below as there might be a new
1123 * "combined4" mode that I need to implement for the SMU bus
1125 if (mode
< pmac_i2c_mode_dumb
|| mode
> pmac_i2c_mode_combined
) {
1126 printk(KERN_ERR
"low_i2c: Invalid mode %d requested on"
1127 " bus %s !\n", mode
, bus
->busnode
->full_name
);
1134 EXPORT_SYMBOL_GPL(pmac_i2c_setmode
);
1136 int pmac_i2c_xfer(struct pmac_i2c_bus
*bus
, u8 addrdir
, int subsize
,
1137 u32 subaddr
, u8
*data
, int len
)
1141 WARN_ON(!bus
->opened
);
1143 DBG("xfer() chan=%d, addrdir=0x%x, mode=%d, subsize=%d, subaddr=0x%x,"
1144 " %d bytes, bus %s\n", bus
->channel
, addrdir
, bus
->mode
, subsize
,
1145 subaddr
, len
, bus
->busnode
->full_name
);
1147 rc
= bus
->xfer(bus
, addrdir
, subsize
, subaddr
, data
, len
);
1151 DBG("xfer error %d\n", rc
);
1155 EXPORT_SYMBOL_GPL(pmac_i2c_xfer
);
1157 /* some quirks for platform function decoding */
1159 pmac_i2c_quirk_invmask
= 0x00000001u
,
1160 pmac_i2c_quirk_skip
= 0x00000002u
,
1163 static void pmac_i2c_devscan(void (*callback
)(struct device_node
*dev
,
1166 struct pmac_i2c_bus
*bus
;
1167 struct device_node
*np
;
1168 static struct whitelist_ent
{
1173 /* XXX Study device-tree's & apple drivers are get the quirks
1176 /* Workaround: It seems that running the clockspreading
1177 * properties on the eMac will cause lockups during boot.
1178 * The machine seems to work fine without that. So for now,
1179 * let's make sure i2c-hwclock doesn't match about "imic"
1180 * clocks and we'll figure out if we really need to do
1181 * something special about those later.
1183 { "i2c-hwclock", "imic5002", pmac_i2c_quirk_skip
},
1184 { "i2c-hwclock", "imic5003", pmac_i2c_quirk_skip
},
1185 { "i2c-hwclock", NULL
, pmac_i2c_quirk_invmask
},
1186 { "i2c-cpu-voltage", NULL
, 0},
1187 { "temp-monitor", NULL
, 0 },
1188 { "supply-monitor", NULL
, 0 },
1192 /* Only some devices need to have platform functions instanciated
1193 * here. For now, we have a table. Others, like 9554 i2c GPIOs used
1194 * on Xserve, if we ever do a driver for them, will use their own
1195 * platform function instance
1197 list_for_each_entry(bus
, &pmac_i2c_busses
, link
) {
1199 (np
= of_get_next_child(bus
->busnode
, np
)) != NULL
;) {
1200 struct whitelist_ent
*p
;
1201 /* If multibus, check if device is on that bus */
1202 if (bus
->flags
& pmac_i2c_multibus
)
1203 if (bus
!= pmac_i2c_find_bus(np
))
1205 for (p
= whitelist
; p
->name
!= NULL
; p
++) {
1206 if (strcmp(np
->name
, p
->name
))
1208 if (p
->compatible
&&
1209 !of_device_is_compatible(np
, p
->compatible
))
1211 if (p
->quirks
& pmac_i2c_quirk_skip
)
1213 callback(np
, p
->quirks
);
1220 #define MAX_I2C_DATA 64
1222 struct pmac_i2c_pf_inst
1224 struct pmac_i2c_bus
*bus
;
1226 u8 buffer
[MAX_I2C_DATA
];
1227 u8 scratch
[MAX_I2C_DATA
];
1232 static void* pmac_i2c_do_begin(struct pmf_function
*func
, struct pmf_args
*args
)
1234 struct pmac_i2c_pf_inst
*inst
;
1235 struct pmac_i2c_bus
*bus
;
1237 bus
= pmac_i2c_find_bus(func
->node
);
1239 printk(KERN_ERR
"low_i2c: Can't find bus for %s (pfunc)\n",
1240 func
->node
->full_name
);
1243 if (pmac_i2c_open(bus
, 0)) {
1244 printk(KERN_ERR
"low_i2c: Can't open i2c bus for %s (pfunc)\n",
1245 func
->node
->full_name
);
1249 /* XXX might need GFP_ATOMIC when called during the suspend process,
1250 * but then, there are already lots of issues with suspending when
1251 * near OOM that need to be resolved, the allocator itself should
1252 * probably make GFP_NOIO implicit during suspend
1254 inst
= kzalloc(sizeof(struct pmac_i2c_pf_inst
), GFP_KERNEL
);
1256 pmac_i2c_close(bus
);
1260 inst
->addr
= pmac_i2c_get_dev_addr(func
->node
);
1261 inst
->quirks
= (int)(long)func
->driver_data
;
1265 static void pmac_i2c_do_end(struct pmf_function
*func
, void *instdata
)
1267 struct pmac_i2c_pf_inst
*inst
= instdata
;
1271 pmac_i2c_close(inst
->bus
);
1276 static int pmac_i2c_do_read(PMF_STD_ARGS
, u32 len
)
1278 struct pmac_i2c_pf_inst
*inst
= instdata
;
1281 return pmac_i2c_xfer(inst
->bus
, inst
->addr
| pmac_i2c_read
, 0, 0,
1285 static int pmac_i2c_do_write(PMF_STD_ARGS
, u32 len
, const u8
*data
)
1287 struct pmac_i2c_pf_inst
*inst
= instdata
;
1289 return pmac_i2c_xfer(inst
->bus
, inst
->addr
| pmac_i2c_write
, 0, 0,
1293 /* This function is used to do the masking & OR'ing for the "rmw" type
1294 * callbacks. Ze should apply the mask and OR in the values in the
1295 * buffer before writing back. The problem is that it seems that
1296 * various darwin drivers implement the mask/or differently, thus
1297 * we need to check the quirks first
1299 static void pmac_i2c_do_apply_rmw(struct pmac_i2c_pf_inst
*inst
,
1300 u32 len
, const u8
*mask
, const u8
*val
)
1304 if (inst
->quirks
& pmac_i2c_quirk_invmask
) {
1305 for (i
= 0; i
< len
; i
++)
1306 inst
->scratch
[i
] = (inst
->buffer
[i
] & mask
[i
]) | val
[i
];
1308 for (i
= 0; i
< len
; i
++)
1309 inst
->scratch
[i
] = (inst
->buffer
[i
] & ~mask
[i
])
1310 | (val
[i
] & mask
[i
]);
1314 static int pmac_i2c_do_rmw(PMF_STD_ARGS
, u32 masklen
, u32 valuelen
,
1315 u32 totallen
, const u8
*maskdata
,
1316 const u8
*valuedata
)
1318 struct pmac_i2c_pf_inst
*inst
= instdata
;
1320 if (masklen
> inst
->bytes
|| valuelen
> inst
->bytes
||
1321 totallen
> inst
->bytes
|| valuelen
> masklen
)
1324 pmac_i2c_do_apply_rmw(inst
, masklen
, maskdata
, valuedata
);
1326 return pmac_i2c_xfer(inst
->bus
, inst
->addr
| pmac_i2c_write
, 0, 0,
1327 inst
->scratch
, totallen
);
1330 static int pmac_i2c_do_read_sub(PMF_STD_ARGS
, u8 subaddr
, u32 len
)
1332 struct pmac_i2c_pf_inst
*inst
= instdata
;
1335 return pmac_i2c_xfer(inst
->bus
, inst
->addr
| pmac_i2c_read
, 1, subaddr
,
1339 static int pmac_i2c_do_write_sub(PMF_STD_ARGS
, u8 subaddr
, u32 len
,
1342 struct pmac_i2c_pf_inst
*inst
= instdata
;
1344 return pmac_i2c_xfer(inst
->bus
, inst
->addr
| pmac_i2c_write
, 1,
1345 subaddr
, (u8
*)data
, len
);
1348 static int pmac_i2c_do_set_mode(PMF_STD_ARGS
, int mode
)
1350 struct pmac_i2c_pf_inst
*inst
= instdata
;
1352 return pmac_i2c_setmode(inst
->bus
, mode
);
1355 static int pmac_i2c_do_rmw_sub(PMF_STD_ARGS
, u8 subaddr
, u32 masklen
,
1356 u32 valuelen
, u32 totallen
, const u8
*maskdata
,
1357 const u8
*valuedata
)
1359 struct pmac_i2c_pf_inst
*inst
= instdata
;
1361 if (masklen
> inst
->bytes
|| valuelen
> inst
->bytes
||
1362 totallen
> inst
->bytes
|| valuelen
> masklen
)
1365 pmac_i2c_do_apply_rmw(inst
, masklen
, maskdata
, valuedata
);
1367 return pmac_i2c_xfer(inst
->bus
, inst
->addr
| pmac_i2c_write
, 1,
1368 subaddr
, inst
->scratch
, totallen
);
1371 static int pmac_i2c_do_mask_and_comp(PMF_STD_ARGS
, u32 len
,
1373 const u8
*valuedata
)
1375 struct pmac_i2c_pf_inst
*inst
= instdata
;
1378 /* Get return value pointer, it's assumed to be a u32 */
1379 if (!args
|| !args
->count
|| !args
->u
[0].p
)
1383 if (len
> inst
->bytes
)
1386 for (i
= 0, match
= 1; match
&& i
< len
; i
++)
1387 if ((inst
->buffer
[i
] & maskdata
[i
]) != valuedata
[i
])
1389 *args
->u
[0].p
= match
;
1393 static int pmac_i2c_do_delay(PMF_STD_ARGS
, u32 duration
)
1395 msleep((duration
+ 999) / 1000);
1400 static struct pmf_handlers pmac_i2c_pfunc_handlers
= {
1401 .begin
= pmac_i2c_do_begin
,
1402 .end
= pmac_i2c_do_end
,
1403 .read_i2c
= pmac_i2c_do_read
,
1404 .write_i2c
= pmac_i2c_do_write
,
1405 .rmw_i2c
= pmac_i2c_do_rmw
,
1406 .read_i2c_sub
= pmac_i2c_do_read_sub
,
1407 .write_i2c_sub
= pmac_i2c_do_write_sub
,
1408 .rmw_i2c_sub
= pmac_i2c_do_rmw_sub
,
1409 .set_i2c_mode
= pmac_i2c_do_set_mode
,
1410 .mask_and_compare
= pmac_i2c_do_mask_and_comp
,
1411 .delay
= pmac_i2c_do_delay
,
1414 static void __init
pmac_i2c_dev_create(struct device_node
*np
, int quirks
)
1416 DBG("dev_create(%s)\n", np
->full_name
);
1418 pmf_register_driver(np
, &pmac_i2c_pfunc_handlers
,
1419 (void *)(long)quirks
);
1422 static void __init
pmac_i2c_dev_init(struct device_node
*np
, int quirks
)
1424 DBG("dev_create(%s)\n", np
->full_name
);
1426 pmf_do_functions(np
, NULL
, 0, PMF_FLAGS_ON_INIT
, NULL
);
1429 static void pmac_i2c_dev_suspend(struct device_node
*np
, int quirks
)
1431 DBG("dev_suspend(%s)\n", np
->full_name
);
1432 pmf_do_functions(np
, NULL
, 0, PMF_FLAGS_ON_SLEEP
, NULL
);
1435 static void pmac_i2c_dev_resume(struct device_node
*np
, int quirks
)
1437 DBG("dev_resume(%s)\n", np
->full_name
);
1438 pmf_do_functions(np
, NULL
, 0, PMF_FLAGS_ON_WAKE
, NULL
);
1441 void pmac_pfunc_i2c_suspend(void)
1443 pmac_i2c_devscan(pmac_i2c_dev_suspend
);
1446 void pmac_pfunc_i2c_resume(void)
1448 pmac_i2c_devscan(pmac_i2c_dev_resume
);
1452 * Initialize us: probe all i2c busses on the machine, instantiate
1453 * busses and platform functions as needed.
1455 /* This is non-static as it might be called early by smp code */
1456 int __init
pmac_i2c_init(void)
1458 static int i2c_inited
;
1464 /* Probe keywest-i2c busses */
1467 #ifdef CONFIG_ADB_PMU
1468 /* Probe PMU i2c busses */
1472 #ifdef CONFIG_PMAC_SMU
1473 /* Probe SMU i2c busses */
1477 /* Now add plaform functions for some known devices */
1478 pmac_i2c_devscan(pmac_i2c_dev_create
);
1482 machine_arch_initcall(powermac
, pmac_i2c_init
);
1484 /* Since pmac_i2c_init can be called too early for the platform device
1485 * registration, we need to do it at a later time. In our case, subsys
1486 * happens to fit well, though I agree it's a bit of a hack...
1488 static int __init
pmac_i2c_create_platform_devices(void)
1490 struct pmac_i2c_bus
*bus
;
1493 /* In the case where we are initialized from smp_init(), we must
1494 * not use the timer (and thus the irq). It's safe from now on
1497 pmac_i2c_force_poll
= 0;
1499 /* Create platform devices */
1500 list_for_each_entry(bus
, &pmac_i2c_busses
, link
) {
1502 platform_device_alloc("i2c-powermac", i
++);
1503 if (bus
->platform_dev
== NULL
)
1505 bus
->platform_dev
->dev
.platform_data
= bus
;
1506 platform_device_add(bus
->platform_dev
);
1509 /* Now call platform "init" functions */
1510 pmac_i2c_devscan(pmac_i2c_dev_init
);
1514 machine_subsys_initcall(powermac
, pmac_i2c_create_platform_devices
);