1 /* drivers/i2c/busses/i2c-rk30-adapter.c
3 * Copyright (C) 2012 ROCKCHIP, Inc.
5 * This software is licensed under the terms of the GNU General Public
6 * License version 2, as published by the Free Software Foundation, and
7 * may be copied, distributed, and modified under those terms.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
17 #define COMPLETE_READ (1<<STATE_START|1<<STATE_READ|1<<STATE_STOP)
18 #define COMPLETE_WRITE (1<<STATE_START|1<<STATE_WRITE|1<<STATE_STOP)
20 /* Control register */
22 #define I2C_CON_EN (1 << 0)
23 #define I2C_CON_MOD(mod) ((mod) << 1)
24 #define I2C_CON_MASK (3 << 1)
31 #define I2C_CON_START (1 << 3)
32 #define I2C_CON_STOP (1 << 4)
33 #define I2C_CON_LASTACK (1 << 5)
34 #define I2C_CON_ACTACK (1 << 6)
36 /* Clock dividor register */
37 #define I2C_CLKDIV 0x004
38 #define I2C_CLKDIV_VAL(divl, divh) (((divl) & 0xffff) | (((divh) << 16) & 0xffff0000))
40 /* the slave address accessed for master rx mode */
41 #define I2C_MRXADDR 0x008
42 #define I2C_MRXADDR_LOW (1 << 24)
43 #define I2C_MRXADDR_MID (1 << 25)
44 #define I2C_MRXADDR_HIGH (1 << 26)
46 /* the slave register address accessed for master rx mode */
47 #define I2C_MRXRADDR 0x00c
48 #define I2C_MRXRADDR_LOW (1 << 24)
49 #define I2C_MRXRADDR_MID (1 << 25)
50 #define I2C_MRXRADDR_HIGH (1 << 26)
53 #define I2C_MTXCNT 0x010
56 #define I2C_MRXCNT 0x014
58 /* interrupt enable register */
60 #define I2C_BTFIEN (1 << 0)
61 #define I2C_BRFIEN (1 << 1)
62 #define I2C_MBTFIEN (1 << 2)
63 #define I2C_MBRFIEN (1 << 3)
64 #define I2C_STARTIEN (1 << 4)
65 #define I2C_STOPIEN (1 << 5)
66 #define I2C_NAKRCVIEN (1 << 6)
67 #define IRQ_MST_ENABLE (I2C_MBTFIEN | I2C_MBRFIEN | I2C_NAKRCVIEN | I2C_STARTIEN | I2C_STOPIEN)
68 #define IRQ_ALL_DISABLE 0
70 /* interrupt pending register */
72 #define I2C_BTFIPD (1 << 0)
73 #define I2C_BRFIPD (1 << 1)
74 #define I2C_MBTFIPD (1 << 2)
75 #define I2C_MBRFIPD (1 << 3)
76 #define I2C_STARTIPD (1 << 4)
77 #define I2C_STOPIPD (1 << 5)
78 #define I2C_NAKRCVIPD (1 << 6)
79 #define I2C_IPD_ALL_CLEAN 0x7f
82 #define I2C_FCNT 0x020
84 /* I2C tx data register */
85 #define I2C_TXDATA_BASE 0X100
87 /* I2C rx data register */
88 #define I2C_RXDATA_BASE 0x200
91 static void rk30_show_regs(struct rk30_i2c *i2c)
94 dev_info(i2c->dev, "i2c->clk = %lu\n", clk_get_rate(i2c->clk));
95 dev_info(i2c->dev, "i2c->start = %d\n", i2c->state);
96 dev_info(i2c->dev, "I2C_CON: 0x%08x\n", i2c_readl(i2c->regs + I2C_CON));
97 dev_info(i2c->dev, "I2C_CLKDIV: 0x%08x\n", i2c_readl(i2c->regs + I2C_CLKDIV));
98 dev_info(i2c->dev, "I2C_MRXADDR: 0x%08x\n", i2c_readl(i2c->regs + I2C_MRXADDR));
99 dev_info(i2c->dev, "I2C_MRXRADDR: 0x%08x\n", i2c_readl(i2c->regs + I2C_MRXRADDR));
100 dev_info(i2c->dev, "I2C_MTXCNT: 0x%08x\n", i2c_readl(i2c->regs + I2C_MTXCNT));
101 dev_info(i2c->dev, "I2C_MRXCNT: 0x%08x\n", i2c_readl(i2c->regs + I2C_MRXCNT));
102 dev_info(i2c->dev, "I2C_IEN: 0x%08x\n", i2c_readl(i2c->regs + I2C_IEN));
103 dev_info(i2c->dev, "I2C_IPD: 0x%08x\n", i2c_readl(i2c->regs + I2C_IPD));
104 dev_info(i2c->dev, "I2C_FCNT: 0x%08x\n", i2c_readl(i2c->regs + I2C_FCNT));
105 for( i = 0; i < 8; i ++)
106 dev_info(i2c->dev, "I2C_TXDATA%d: 0x%08x\n", i, i2c_readl(i2c->regs + I2C_TXDATA_BASE + i * 4));
107 for( i = 0; i < 8; i ++)
108 dev_info(i2c->dev, "I2C_RXDATA%d: 0x%08x\n", i, i2c_readl(i2c->regs + I2C_RXDATA_BASE + i * 4));
110 static inline void rk30_i2c_enable(struct rk30_i2c *i2c, unsigned int lastnak)
112 unsigned int con = 0;
115 con |= I2C_CON_MOD(i2c->mode);
117 con |= I2C_CON_LASTACK;
118 con |= I2C_CON_START;
119 i2c_writel(con, i2c->regs + I2C_CON);
121 static inline void rk30_i2c_disable(struct rk30_i2c *i2c)
123 i2c_writel( 0, i2c->regs + I2C_CON);
126 static inline void rk30_i2c_clean_start(struct rk30_i2c *i2c)
128 unsigned int con = i2c_readl(i2c->regs + I2C_CON);
130 con &= ~I2C_CON_START;
131 i2c_writel(con, i2c->regs + I2C_CON);
133 static inline void rk30_i2c_send_start(struct rk30_i2c *i2c)
135 unsigned int con = i2c_readl(i2c->regs + I2C_CON);
137 con |= I2C_CON_START;
138 if(con & I2C_CON_STOP)
139 dev_warn(i2c->dev, "I2C_CON: stop bit is set\n");
141 i2c_writel(con, i2c->regs + I2C_CON);
143 static inline void rk30_i2c_send_stop(struct rk30_i2c *i2c)
145 unsigned int con = i2c_readl(i2c->regs + I2C_CON);
148 if(con & I2C_CON_START)
149 dev_warn(i2c->dev, "I2C_CON: start bit is set\n");
151 i2c_writel(con, i2c->regs + I2C_CON);
153 static inline void rk30_i2c_clean_stop(struct rk30_i2c *i2c)
155 unsigned int con = i2c_readl(i2c->regs + I2C_CON);
157 con &= ~I2C_CON_STOP;
158 i2c_writel(con, i2c->regs + I2C_CON);
161 static inline void rk30_i2c_disable_irq(struct rk30_i2c *i2c)
163 i2c_writel(IRQ_ALL_DISABLE, i2c->regs + I2C_IEN);
166 static inline void rk30_i2c_enable_irq(struct rk30_i2c *i2c)
168 i2c_writel(IRQ_MST_ENABLE, i2c->regs + I2C_IEN);
171 /* SCL Divisor = 8 * (CLKDIVL + CLKDIVH)
172 * SCL = i2c_rate/ SCLK Divisor
174 static void rk30_i2c_set_clk(struct rk30_i2c *i2c, unsigned long scl_rate)
176 unsigned long i2c_rate = clk_get_rate(i2c->clk);
178 unsigned int div, divl, divh;
180 if((scl_rate == i2c->scl_rate) && (i2c_rate == i2c->i2c_rate))
182 i2c->i2c_rate = i2c_rate;
183 i2c->scl_rate = scl_rate;
184 div = rk30_ceil(i2c_rate, scl_rate * 8);
185 divh = divl = rk30_ceil(div, 2);
186 i2c_writel(I2C_CLKDIV_VAL(divl, divh), i2c->regs + I2C_CLKDIV);
187 i2c_dbg(i2c->dev, "set clk(I2C_CLKDIV: 0x%08x)\n", i2c_readl(i2c->regs + I2C_CLKDIV));
190 static void rk30_i2c_init_hw(struct rk30_i2c *i2c, unsigned long scl_rate)
193 rk30_i2c_set_clk(i2c, scl_rate);
196 /* returns TRUE if we this is the last byte in the current message */
197 static inline int is_msglast(struct rk30_i2c *i2c)
199 return i2c->msg_ptr == i2c->msg->len-1;
202 /* returns TRUE if we reached the end of the current message */
203 static inline int is_msgend(struct rk30_i2c *i2c)
205 return i2c->msg_ptr >= i2c->msg->len;
208 static void rk30_i2c_stop(struct rk30_i2c *i2c, int ret)
214 i2c->state = STATE_IDLE;
220 i2c_writel(I2C_STOPIEN, i2c->regs + I2C_IEN);
221 i2c->state = STATE_STOP;
222 rk30_i2c_send_stop(i2c);
225 static inline void rk30_set_rx_mode(struct rk30_i2c *i2c, unsigned int lastnak)
227 unsigned long con = i2c_readl(i2c->regs + I2C_CON);
229 con &= (~I2C_CON_MASK);
230 con |= (I2C_CON_MOD_RX << 1);
232 con |= I2C_CON_LASTACK;
233 i2c_writel(con, i2c->regs + I2C_CON);
235 static void rk30_irq_read_prepare(struct rk30_i2c *i2c)
237 unsigned int cnt, len = i2c->msg->len - i2c->msg_ptr;
239 if(len <= 32 && i2c->msg_ptr != 0)
240 rk30_set_rx_mode(i2c, 1);
241 else if(i2c->msg_ptr != 0)
242 rk30_set_rx_mode(i2c, 0);
245 rk30_i2c_stop(i2c, i2c->error);
252 i2c_writel(cnt, i2c->regs + I2C_MRXCNT);
254 static void rk30_irq_read_get_data(struct rk30_i2c *i2c)
256 unsigned int i, len = i2c->msg->len - i2c->msg_ptr;
259 len = (len >= 32)?32:len;
261 for(i = 0; i < len; i++){
263 p = i2c_readl(i2c->regs + I2C_RXDATA_BASE + (i/4) * 4);
264 i2c->msg->buf[i2c->msg_ptr++] = (p >>((i%4) * 8)) & 0xff;
269 static void rk30_irq_write_prepare(struct rk30_i2c *i2c)
271 unsigned int data = 0, cnt = 0, i, j;
275 rk30_i2c_stop(i2c, i2c->error);
278 for(i = 0; i < 8; i++){
280 for(j = 0; j < 4; j++) {
283 if(i2c->msg_ptr == 0 && cnt == 0)
284 byte = (i2c->addr & 0x7f) << 1;
286 byte = i2c->msg->buf[i2c->msg_ptr++];
288 data |= (byte << (j * 8));
290 i2c_writel(data, i2c->regs + I2C_TXDATA_BASE + 4 * i);
294 i2c_writel(cnt, i2c->regs + I2C_MTXCNT);
296 static void rk30_i2c_irq_nextblock(struct rk30_i2c *i2c, unsigned int ipd)
298 switch (i2c->state) {
300 if(!(ipd & I2C_STARTIPD)){
301 rk30_i2c_stop(i2c, -ENXIO);
302 dev_err(i2c->dev, "Addr[0x%02x] no start irq in STATE_START\n", i2c->addr);
304 i2c_writel(I2C_IPD_ALL_CLEAN, i2c->regs + I2C_IPD);
307 i2c->complete_what |= 1<<i2c->state;
308 i2c_writel(I2C_STARTIPD, i2c->regs + I2C_IPD);
309 rk30_i2c_clean_start(i2c);
310 if(i2c->mode == I2C_CON_MOD_TX){
311 i2c_writel(I2C_MBTFIEN | I2C_NAKRCVIEN, i2c->regs + I2C_IEN);
312 i2c->state = STATE_WRITE;
315 i2c_writel(I2C_MBRFIEN | I2C_NAKRCVIEN, i2c->regs + I2C_IEN);
316 i2c->state = STATE_READ;
320 if(!(ipd & I2C_MBTFIPD)){
321 rk30_i2c_stop(i2c, -ENXIO);
322 dev_err(i2c->dev, "Addr[0x%02x] no mbtf irq in STATE_WRITE\n", i2c->addr);
324 i2c_writel(I2C_IPD_ALL_CLEAN, i2c->regs + I2C_IPD);
327 i2c->complete_what |= 1<<i2c->state;
328 i2c_writel(I2C_MBTFIPD, i2c->regs + I2C_IPD);
330 rk30_irq_write_prepare(i2c);
333 if(!(ipd & I2C_MBRFIPD)){
334 rk30_i2c_stop(i2c, -ENXIO);
335 dev_err(i2c->dev, "Addr[0x%02x] no mbrf irq in STATE_READ, ipd = 0x%x\n", i2c->addr, ipd);
337 i2c_writel(I2C_IPD_ALL_CLEAN, i2c->regs + I2C_IPD);
340 i2c->complete_what |= 1<<i2c->state;
341 i2c_writel(I2C_MBRFIPD, i2c->regs + I2C_IPD);
342 rk30_irq_read_get_data(i2c);
344 rk30_irq_read_prepare(i2c);
347 if(!(ipd & I2C_STOPIPD)){
348 rk30_i2c_stop(i2c, -ENXIO);
349 dev_err(i2c->dev, "Addr[0x%02x] no stop irq in STATE_STOP\n", i2c->addr);
351 i2c_writel(I2C_IPD_ALL_CLEAN, i2c->regs + I2C_IPD);
354 rk30_i2c_clean_stop(i2c);
355 i2c_writel(I2C_STOPIPD, i2c->regs + I2C_IPD);
357 i2c->complete_what |= 1<<i2c->state;
358 i2c->state = STATE_IDLE;
367 static irqreturn_t rk30_i2c_irq(int irq, void *dev_id)
369 struct rk30_i2c *i2c = dev_id;
372 spin_lock(&i2c->lock);
373 ipd = i2c_readl(i2c->regs + I2C_IPD);
374 if(i2c->state == STATE_IDLE){
375 dev_info(i2c->dev, "Addr[0x%02x] irq in STATE_IDLE, ipd = 0x%x\n", i2c->addr, ipd);
376 i2c_writel(I2C_IPD_ALL_CLEAN, i2c->regs + I2C_IPD);
380 if(ipd & I2C_NAKRCVIPD){
381 i2c_writel(I2C_NAKRCVIPD, i2c->regs + I2C_IPD);
382 i2c->error = -EAGAIN;
385 rk30_i2c_irq_nextblock(i2c, ipd);
387 spin_unlock(&i2c->lock);
392 static int rk30_i2c_set_master(struct rk30_i2c *i2c, struct i2c_msg *msgs, int num)
394 unsigned int addr = (msgs[0].addr & 0x7f) << 1;
395 unsigned int reg_valid_bits = 0;
396 unsigned int reg_addr = 0;
399 i2c->count = msgs[0].len;
400 if(!(msgs[0].flags & I2C_M_RD)){
402 i2c->mode = I2C_CON_MOD_TX;
407 i2c_writel(addr | I2C_MRXADDR_LOW, i2c->regs + I2C_MRXADDR);
408 i2c_writel(0, i2c->regs + I2C_MRXRADDR);
409 i2c->mode = I2C_CON_MOD_TRX;
410 //i2c->mode = I2C_CON_MOD_RX;
414 i2c->count = msgs[1].len;
417 reg_addr = msgs[0].buf[0];
418 reg_valid_bits |= I2C_MRXADDR_LOW;
421 reg_addr = msgs[0].buf[0] | (msgs[0].buf[1] << 8);
422 reg_valid_bits |= I2C_MRXADDR_LOW | I2C_MRXADDR_MID;
425 reg_addr = msgs[0].buf[0] | (msgs[0].buf[1] << 8) | (msgs[0].buf[2] << 16);
426 reg_valid_bits |= I2C_MRXADDR_LOW | I2C_MRXADDR_MID | I2C_MRXADDR_HIGH;
431 if((msgs[0].flags & I2C_M_RD) && (msgs[1].flags & I2C_M_RD)) {
434 i2c_writel(addr | I2C_MRXADDR_LOW, i2c->regs + I2C_MRXADDR);
435 i2c_writel(reg_addr | reg_valid_bits, i2c->regs + I2C_MRXRADDR);
436 i2c->mode = I2C_CON_MOD_RRX;
438 else if(!(msgs[0].flags & I2C_M_RD) && (msgs[1].flags & I2C_M_RD)) {
440 i2c_writel(addr | I2C_MRXADDR_LOW, i2c->regs + I2C_MRXADDR);
441 i2c_writel(reg_addr | reg_valid_bits, i2c->regs + I2C_MRXRADDR);
442 i2c->mode = I2C_CON_MOD_TRX;
448 dev_err(i2c->dev, "This case(num > 2) has not been support now\n");
456 * this starts an i2c transfer
458 static int rk30_i2c_doxfer(struct rk30_i2c *i2c,
459 struct i2c_msg *msgs, int num)
461 unsigned long timeout, flags;
463 /* 32 -- max transfer bytes
464 * 2 -- addr bytes * 2
465 * 3 -- max reg addr bytes
466 * 9 -- cycles per bytes
467 * max cycles: (32 + 2 + 3) * 9 --> 400 cycles
469 int msleep_time = 400 * 1000/ i2c->scl_rate; // ms
472 dev_err(i2c->dev, "i2c is suspended\n");
476 spin_lock_irqsave(&i2c->lock, flags);
477 if(rk30_i2c_set_master(i2c, msgs, num) < 0){
478 spin_unlock_irqrestore(&i2c->lock, flags);
479 dev_err(i2c->dev, "addr[0x%02x] set master error\n", msgs[0].addr);
482 i2c->addr = msgs[0].addr;
486 i2c->state = STATE_START;
487 i2c->complete_what = 0;
488 i2c_writel(I2C_STARTIEN, i2c->regs + I2C_IEN);
489 spin_unlock_irqrestore(&i2c->lock, flags);
491 rk30_i2c_enable(i2c, (i2c->count > 32)?0:1); //if count > 32, byte(32) send ack
493 timeout = wait_event_timeout(i2c->wait, (i2c->is_busy == 0), msecs_to_jiffies(I2C_WAIT_TIMEOUT));
495 spin_lock_irqsave(&i2c->lock, flags);
496 i2c->state = STATE_IDLE;
498 spin_unlock_irqrestore(&i2c->lock, flags);
502 i2c_dbg(i2c->dev, "error = %d\n", error);
503 else if((i2c->complete_what !=COMPLETE_READ && i2c->complete_what != COMPLETE_WRITE)){
504 dev_err(i2c->dev, "Addr[0x%02x] wait event timeout, state: %d, is_busy: %d, error: %d, complete_what: 0x%x, ipd: 0x%x\n",
505 msgs[0].addr, i2c->state, i2c->is_busy, error, i2c->complete_what, i2c_readl(i2c->regs + I2C_IPD));
506 //rk30_show_regs(i2c);
509 rk30_i2c_send_stop(i2c);
513 i2c_dbg(i2c->dev, "Addr[0x%02x] wait event timeout, but transfer complete\n", i2c->addr);
515 i2c_writel(I2C_IPD_ALL_CLEAN, i2c->regs + I2C_IPD);
516 rk30_i2c_disable_irq(i2c);
517 rk30_i2c_disable(i2c);
520 i2c_dbg(i2c->dev, "No ack(complete_what: 0x%x), Maybe slave(addr: 0x%02x) not exist or abnormal power-on\n",
521 i2c->complete_what, i2c->addr);
527 * first port of call from the i2c bus code when an message needs
528 * transferring across the i2c bus.
531 static int rk30_i2c_xfer(struct i2c_adapter *adap,
532 struct i2c_msg *msgs, int num)
534 int ret = 0, state, retry = 10;
535 unsigned long scl_rate;
536 struct rk30_i2c *i2c = (struct rk30_i2c *)adap->algo_data;
538 clk_enable(i2c->clk);
539 while(retry-- && ((state = i2c->check_idle()) != I2C_IDLE)){
543 dev_err(i2c->dev, "i2c is not in idle(state = %d)\n", state);
547 if(msgs[0].scl_rate <= 400000 && msgs[0].scl_rate >= 10000)
548 scl_rate = msgs[0].scl_rate;
549 else if(msgs[0].scl_rate > 400000){
550 dev_warn(i2c->dev, "Warning: addr[0x%x] msg[0].scl_rate( = %dKhz) is too high!",
551 msgs[0].addr, msgs[0].scl_rate/1000);
555 dev_warn(i2c->dev, "Warning: addr[0x%x] msg[0].scl_rate( = %dKhz) is too low!",
556 msgs[0].addr, msgs[0].scl_rate/1000);
559 if(i2c->is_div_from_arm[i2c->adap.nr]){
560 mutex_lock(&i2c->m_lock);
561 wake_lock(&i2c->idlelock[i2c->adap.nr]);
564 rk30_i2c_set_clk(i2c, scl_rate);
565 i2c_dbg(i2c->dev, "i2c transfer start: addr: 0x%x, scl_reate: %ldKhz, len: %d\n", msgs[0].addr, scl_rate/1000, num);
566 ret = rk30_i2c_doxfer(i2c, msgs, num);
567 i2c_dbg(i2c->dev, "i2c transfer stop: addr: 0x%x, state: %d, ret: %d\n", msgs[0].addr, ret, i2c->state);
569 if(i2c->is_div_from_arm[i2c->adap.nr]){
570 wake_unlock(&i2c->idlelock[i2c->adap.nr]);
571 mutex_unlock(&i2c->m_lock);
574 clk_disable(i2c->clk);
575 return (ret < 0)?ret:num;
578 /* declare our i2c functionality */
579 static u32 rk30_i2c_func(struct i2c_adapter *adap)
581 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL | I2C_FUNC_PROTOCOL_MANGLING;
584 /* i2c bus registration info */
586 static const struct i2c_algorithm rk30_i2c_algorithm = {
587 .master_xfer = rk30_i2c_xfer,
588 .functionality = rk30_i2c_func,
591 int i2c_add_rk30_adapter(struct i2c_adapter *adap)
594 struct rk30_i2c *i2c = (struct rk30_i2c *)adap->algo_data;
596 adap->algo = &rk30_i2c_algorithm;
598 i2c->i2c_init_hw = &rk30_i2c_init_hw;
599 i2c->i2c_set_clk = &rk30_i2c_set_clk;
600 i2c->i2c_irq = &rk30_i2c_irq;
602 ret = i2c_add_numbered_adapter(adap);