drivers/i2c/busses/i2c-sh_mobile.c

   1 /*
   2  * SuperH Mobile I2C Controller
   3  *
   4  * Copyright (C) 2014 Wolfram Sang <wsa@sang-engineering.com>
   5  *
   6  * Copyright (C) 2008 Magnus Damm
   7  *
   8  * Portions of the code based on out-of-tree driver i2c-sh7343.c
   9  * Copyright (c) 2006 Carlos Munoz <carlos@kenati.com>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  */
  20
  21 #include <linux/clk.h>
  22 #include <linux/delay.h>
  23 #include <linux/dmaengine.h>
  24 #include <linux/dma-mapping.h>
  25 #include <linux/err.h>
  26 #include <linux/i2c.h>
  27 #include <linux/i2c/i2c-sh_mobile.h>
  28 #include <linux/init.h>
  29 #include <linux/interrupt.h>
  30 #include <linux/io.h>
  31 #include <linux/kernel.h>
  32 #include <linux/module.h>
  33 #include <linux/of_device.h>
  34 #include <linux/platform_device.h>
  35 #include <linux/pm_runtime.h>
  36 #include <linux/slab.h>
  37
  38 /* Transmit operation:                                                      */
  39 /*                                                                          */
  40 /* 0 byte transmit                                                          */
  41 /* BUS:     S     A8     ACK   P(*)                                         */
  42 /* IRQ:       DTE   WAIT                                                    */
  43 /* ICIC:                                                                    */
  44 /* ICCR: 0x94 0x90                                                          */
  45 /* ICDR:      A8                                                            */
  46 /*                                                                          */
  47 /* 1 byte transmit                                                          */
  48 /* BUS:     S     A8     ACK   D8(1)   ACK   P(*)                           */
  49 /* IRQ:       DTE   WAIT         WAIT                                       */
  50 /* ICIC:      -DTE                                                          */
  51 /* ICCR: 0x94       0x90                                                    */
  52 /* ICDR:      A8    D8(1)                                                   */
  53 /*                                                                          */
  54 /* 2 byte transmit                                                          */
  55 /* BUS:     S     A8     ACK   D8(1)   ACK   D8(2)   ACK   P(*)             */
  56 /* IRQ:       DTE   WAIT         WAIT          WAIT                         */
  57 /* ICIC:      -DTE                                                          */
  58 /* ICCR: 0x94                    0x90                                       */
  59 /* ICDR:      A8    D8(1)        D8(2)                                      */
  60 /*                                                                          */
  61 /* 3 bytes or more, +---------+ gets repeated                               */
  62 /*                                                                          */
  63 /*                                                                          */
  64 /* Receive operation:                                                       */
  65 /*                                                                          */
  66 /* 0 byte receive - not supported since slave may hold SDA low              */
  67 /*                                                                          */
  68 /* 1 byte receive       [TX] | [RX]                                         */
  69 /* BUS:     S     A8     ACK | D8(1)   ACK   P(*)                           */
  70 /* IRQ:       DTE   WAIT     |   WAIT     DTE                               */
  71 /* ICIC:      -DTE           |   +DTE                                       */
  72 /* ICCR: 0x94       0x81     |   0xc0                                       */
  73 /* ICDR:      A8             |            D8(1)                             */
  74 /*                                                                          */
  75 /* 2 byte receive        [TX]| [RX]                                         */
  76 /* BUS:     S     A8     ACK | D8(1)   ACK   D8(2)   ACK   P(*)             */
  77 /* IRQ:       DTE   WAIT     |   WAIT          WAIT     DTE                 */
  78 /* ICIC:      -DTE           |                 +DTE                         */
  79 /* ICCR: 0x94       0x81     |                 0xc0                         */
  80 /* ICDR:      A8             |                 D8(1)    D8(2)               */
  81 /*                                                                          */
  82 /* 3 byte receive       [TX] | [RX]                                     (*) */
  83 /* BUS:     S     A8     ACK | D8(1)   ACK   D8(2)   ACK   D8(3)   ACK    P */
  84 /* IRQ:       DTE   WAIT     |   WAIT          WAIT         WAIT      DTE   */
  85 /* ICIC:      -DTE           |                              +DTE            */
  86 /* ICCR: 0x94       0x81     |                              0xc0            */
  87 /* ICDR:      A8             |                 D8(1)        D8(2)     D8(3) */
  88 /*                                                                          */
  89 /* 4 bytes or more, this part is repeated    +---------+                    */
  90 /*                                                                          */
  91 /*                                                                          */
  92 /* Interrupt order and BUSY flag                                            */
  93 /*     ___                                                 _                */
  94 /* SDA ___\___XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXAAAAAAAAA___/                 */
  95 /* SCL      \_/1\_/2\_/3\_/4\_/5\_/6\_/7\_/8\___/9\_____/                   */
  96 /*                                                                          */
  97 /*        S   D7  D6  D5  D4  D3  D2  D1  D0              P(*)              */
  98 /*                                           ___                            */
  99 /* WAIT IRQ ________________________________/   \___________                */
 100 /* TACK IRQ ____________________________________/   \_______                */
 101 /* DTE  IRQ __________________________________________/   \_                */
 102 /* AL   IRQ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX                */
 103 /*         _______________________________________________                  */
 104 /* BUSY __/                                               \_                */
 105 /*                                                                          */
 106 /* (*) The STOP condition is only sent by the master at the end of the last */
 107 /* I2C message or if the I2C_M_STOP flag is set. Similarly, the BUSY bit is */
 108 /* only cleared after the STOP condition, so, between messages we have to   */
 109 /* poll for the DTE bit.                                                    */
 110 /*                                                                          */
 111
 112 enum sh_mobile_i2c_op {
 113         OP_START = 0,
 114         OP_TX_FIRST,
 115         OP_TX,
 116         OP_TX_STOP,
 117         OP_TX_STOP_DATA,
 118         OP_TX_TO_RX,
 119         OP_RX,
 120         OP_RX_STOP,
 121         OP_RX_STOP_DATA,
 122 };
 123
 124 struct sh_mobile_i2c_data {
 125         struct device *dev;
 126         void __iomem *reg;
 127         struct i2c_adapter adap;
 128         unsigned long bus_speed;
 129         unsigned int clks_per_count;
 130         struct clk *clk;
 131         u_int8_t icic;
 132         u_int8_t flags;
 133         u_int16_t iccl;
 134         u_int16_t icch;
 135
 136         spinlock_t lock;
 137         wait_queue_head_t wait;
 138         struct i2c_msg *msg;
 139         int pos;
 140         int sr;
 141         bool send_stop;
 142
 143         struct dma_chan *dma_tx;
 144         struct dma_chan *dma_rx;
 145         struct scatterlist sg;
 146         enum dma_data_direction dma_direction;
 147 };
 148
 149 struct sh_mobile_dt_config {
 150         int clks_per_count;
 151 };
 152
 153 #define IIC_FLAG_HAS_ICIC67     (1 << 0)
 154
 155 #define STANDARD_MODE           100000
 156 #define FAST_MODE               400000
 157
 158 /* Register offsets */
 159 #define ICDR                    0x00
 160 #define ICCR                    0x04
 161 #define ICSR                    0x08
 162 #define ICIC                    0x0c
 163 #define ICCL                    0x10
 164 #define ICCH                    0x14
 165
 166 /* Register bits */
 167 #define ICCR_ICE                0x80
 168 #define ICCR_RACK               0x40
 169 #define ICCR_TRS                0x10
 170 #define ICCR_BBSY               0x04
 171 #define ICCR_SCP                0x01
 172
 173 #define ICSR_SCLM               0x80
 174 #define ICSR_SDAM               0x40
 175 #define SW_DONE                 0x20
 176 #define ICSR_BUSY               0x10
 177 #define ICSR_AL                 0x08
 178 #define ICSR_TACK               0x04
 179 #define ICSR_WAIT               0x02
 180 #define ICSR_DTE                0x01
 181
 182 #define ICIC_ICCLB8             0x80
 183 #define ICIC_ICCHB8             0x40
 184 #define ICIC_TDMAE              0x20
 185 #define ICIC_RDMAE              0x10
 186 #define ICIC_ALE                0x08
 187 #define ICIC_TACKE              0x04
 188 #define ICIC_WAITE              0x02
 189 #define ICIC_DTEE               0x01
 190
 191 static void iic_wr(struct sh_mobile_i2c_data *pd, int offs, unsigned char data)
 192 {
 193         if (offs == ICIC)
 194                 data |= pd->icic;
 195
 196         iowrite8(data, pd->reg + offs);
 197 }
 198
 199 static unsigned char iic_rd(struct sh_mobile_i2c_data *pd, int offs)
 200 {
 201         return ioread8(pd->reg + offs);
 202 }
 203
 204 static void iic_set_clr(struct sh_mobile_i2c_data *pd, int offs,
 205                         unsigned char set, unsigned char clr)
 206 {
 207         iic_wr(pd, offs, (iic_rd(pd, offs) | set) & ~clr);
 208 }
 209
 210 static u32 sh_mobile_i2c_iccl(unsigned long count_khz, u32 tLOW, u32 tf)
 211 {
 212         /*
 213          * Conditional expression:
 214          *   ICCL >= COUNT_CLK * (tLOW + tf)
 215          *
 216          * SH-Mobile IIC hardware starts counting the LOW period of
 217          * the SCL signal (tLOW) as soon as it pulls the SCL line.
 218          * In order to meet the tLOW timing spec, we need to take into
 219          * account the fall time of SCL signal (tf).  Default tf value
 220          * should be 0.3 us, for safety.
 221          */
 222         return (((count_khz * (tLOW + tf)) + 5000) / 10000);
 223 }
 224
 225 static u32 sh_mobile_i2c_icch(unsigned long count_khz, u32 tHIGH, u32 tf)
 226 {
 227         /*
 228          * Conditional expression:
 229          *   ICCH >= COUNT_CLK * (tHIGH + tf)
 230          *
 231          * SH-Mobile IIC hardware is aware of SCL transition period 'tr',
 232          * and can ignore it.  SH-Mobile IIC controller starts counting
 233          * the HIGH period of the SCL signal (tHIGH) after the SCL input
 234          * voltage increases at VIH.
 235          *
 236          * Afterward it turned out calculating ICCH using only tHIGH spec
 237          * will result in violation of the tHD;STA timing spec.  We need
 238          * to take into account the fall time of SDA signal (tf) at START
 239          * condition, in order to meet both tHIGH and tHD;STA specs.
 240          */
 241         return (((count_khz * (tHIGH + tf)) + 5000) / 10000);
 242 }
 243
 244 static int sh_mobile_i2c_init(struct sh_mobile_i2c_data *pd)
 245 {
 246         unsigned long i2c_clk_khz;
 247         u32 tHIGH, tLOW, tf;
 248         uint16_t max_val;
 249
 250         /* Get clock rate after clock is enabled */
 251         clk_prepare_enable(pd->clk);
 252         i2c_clk_khz = clk_get_rate(pd->clk) / 1000;
 253         clk_disable_unprepare(pd->clk);
 254         i2c_clk_khz /= pd->clks_per_count;
 255
 256         if (pd->bus_speed == STANDARD_MODE) {
 257                 tLOW    = 47;   /* tLOW = 4.7 us */
 258                 tHIGH   = 40;   /* tHD;STA = tHIGH = 4.0 us */
 259                 tf      = 3;    /* tf = 0.3 us */
 260         } else if (pd->bus_speed == FAST_MODE) {
 261                 tLOW    = 13;   /* tLOW = 1.3 us */
 262                 tHIGH   = 6;    /* tHD;STA = tHIGH = 0.6 us */
 263                 tf      = 3;    /* tf = 0.3 us */
 264         } else {
 265                 dev_err(pd->dev, "unrecognized bus speed %lu Hz\n",
 266                         pd->bus_speed);
 267                 return -EINVAL;
 268         }
 269
 270         pd->iccl = sh_mobile_i2c_iccl(i2c_clk_khz, tLOW, tf);
 271         pd->icch = sh_mobile_i2c_icch(i2c_clk_khz, tHIGH, tf);
 272
 273         max_val = pd->flags & IIC_FLAG_HAS_ICIC67 ? 0x1ff : 0xff;
 274         if (pd->iccl > max_val || pd->icch > max_val) {
 275                 dev_err(pd->dev, "timing values out of range: L/H=0x%x/0x%x\n",
 276                         pd->iccl, pd->icch);
 277                 return -EINVAL;
 278         }
 279
 280         /* one more bit of ICCL in ICIC */
 281         if (pd->iccl & 0x100)
 282                 pd->icic |= ICIC_ICCLB8;
 283         else
 284                 pd->icic &= ~ICIC_ICCLB8;
 285
 286         /* one more bit of ICCH in ICIC */
 287         if (pd->icch & 0x100)
 288                 pd->icic |= ICIC_ICCHB8;
 289         else
 290                 pd->icic &= ~ICIC_ICCHB8;
 291
 292         return 0;
 293 }
 294
 295 static void activate_ch(struct sh_mobile_i2c_data *pd)
 296 {
 297         /* Wake up device and enable clock */
 298         pm_runtime_get_sync(pd->dev);
 299         clk_prepare_enable(pd->clk);
 300
 301         /* Enable channel and configure rx ack */
 302         iic_set_clr(pd, ICCR, ICCR_ICE, 0);
 303
 304         /* Mask all interrupts */
 305         iic_wr(pd, ICIC, 0);
 306
 307         /* Set the clock */
 308         iic_wr(pd, ICCL, pd->iccl & 0xff);
 309         iic_wr(pd, ICCH, pd->icch & 0xff);
 310 }
 311
 312 static void deactivate_ch(struct sh_mobile_i2c_data *pd)
 313 {
 314         /* Clear/disable interrupts */
 315         iic_wr(pd, ICSR, 0);
 316         iic_wr(pd, ICIC, 0);
 317
 318         /* Disable channel */
 319         iic_set_clr(pd, ICCR, 0, ICCR_ICE);
 320
 321         /* Disable clock and mark device as idle */
 322         clk_disable_unprepare(pd->clk);
 323         pm_runtime_put_sync(pd->dev);
 324 }
 325
 326 static unsigned char i2c_op(struct sh_mobile_i2c_data *pd,
 327                             enum sh_mobile_i2c_op op, unsigned char data)
 328 {
 329         unsigned char ret = 0;
 330         unsigned long flags;
 331
 332         dev_dbg(pd->dev, "op %d, data in 0x%02x\n", op, data);
 333
 334         spin_lock_irqsave(&pd->lock, flags);
 335
 336         switch (op) {
 337         case OP_START: /* issue start and trigger DTE interrupt */
 338                 iic_wr(pd, ICCR, ICCR_ICE | ICCR_TRS | ICCR_BBSY);
 339                 break;
 340         case OP_TX_FIRST: /* disable DTE interrupt and write data */
 341                 iic_wr(pd, ICIC, ICIC_WAITE | ICIC_ALE | ICIC_TACKE);
 342                 iic_wr(pd, ICDR, data);
 343                 break;
 344         case OP_TX: /* write data */
 345                 iic_wr(pd, ICDR, data);
 346                 break;
 347         case OP_TX_STOP_DATA: /* write data and issue a stop afterwards */
 348                 iic_wr(pd, ICDR, data);
 349                 /* fallthrough */
 350         case OP_TX_STOP: /* issue a stop */
 351                 iic_wr(pd, ICCR, pd->send_stop ? ICCR_ICE | ICCR_TRS
 352                                                : ICCR_ICE | ICCR_TRS | ICCR_BBSY);
 353                 break;
 354         case OP_TX_TO_RX: /* select read mode */
 355                 iic_wr(pd, ICCR, ICCR_ICE | ICCR_SCP);
 356                 break;
 357         case OP_RX: /* just read data */
 358                 ret = iic_rd(pd, ICDR);
 359                 break;
 360         case OP_RX_STOP: /* enable DTE interrupt, issue stop */
 361                 iic_wr(pd, ICIC,
 362                        ICIC_DTEE | ICIC_WAITE | ICIC_ALE | ICIC_TACKE);
 363                 iic_wr(pd, ICCR, ICCR_ICE | ICCR_RACK);
 364                 break;
 365         case OP_RX_STOP_DATA: /* enable DTE interrupt, read data, issue stop */
 366                 iic_wr(pd, ICIC,
 367                        ICIC_DTEE | ICIC_WAITE | ICIC_ALE | ICIC_TACKE);
 368                 ret = iic_rd(pd, ICDR);
 369                 iic_wr(pd, ICCR, ICCR_ICE | ICCR_RACK);
 370                 break;
 371         }
 372
 373         spin_unlock_irqrestore(&pd->lock, flags);
 374
 375         dev_dbg(pd->dev, "op %d, data out 0x%02x\n", op, ret);
 376         return ret;
 377 }
 378
 379 static bool sh_mobile_i2c_is_first_byte(struct sh_mobile_i2c_data *pd)
 380 {
 381         return pd->pos == -1;
 382 }
 383
 384 static bool sh_mobile_i2c_is_last_byte(struct sh_mobile_i2c_data *pd)
 385 {
 386         return pd->pos == pd->msg->len - 1;
 387 }
 388
 389 static void sh_mobile_i2c_get_data(struct sh_mobile_i2c_data *pd,
 390                                    unsigned char *buf)
 391 {
 392         switch (pd->pos) {
 393         case -1:
 394                 *buf = (pd->msg->addr & 0x7f) << 1;
 395                 *buf |= (pd->msg->flags & I2C_M_RD) ? 1 : 0;
 396                 break;
 397         default:
 398                 *buf = pd->msg->buf[pd->pos];
 399         }
 400 }
 401
 402 static int sh_mobile_i2c_isr_tx(struct sh_mobile_i2c_data *pd)
 403 {
 404         unsigned char data;
 405
 406         if (pd->pos == pd->msg->len) {
 407                 /* Send stop if we haven't yet (DMA case) */
 408                 if (pd->send_stop && (iic_rd(pd, ICCR) & ICCR_BBSY))
 409                         i2c_op(pd, OP_TX_STOP, 0);
 410                 return 1;
 411         }
 412
 413         sh_mobile_i2c_get_data(pd, &data);
 414
 415         if (sh_mobile_i2c_is_last_byte(pd))
 416                 i2c_op(pd, OP_TX_STOP_DATA, data);
 417         else if (sh_mobile_i2c_is_first_byte(pd))
 418                 i2c_op(pd, OP_TX_FIRST, data);
 419         else
 420                 i2c_op(pd, OP_TX, data);
 421
 422         pd->pos++;
 423         return 0;
 424 }
 425
 426 static int sh_mobile_i2c_isr_rx(struct sh_mobile_i2c_data *pd)
 427 {
 428         unsigned char data;
 429         int real_pos;
 430
 431         do {
 432                 if (pd->pos <= -1) {
 433                         sh_mobile_i2c_get_data(pd, &data);
 434
 435                         if (sh_mobile_i2c_is_first_byte(pd))
 436                                 i2c_op(pd, OP_TX_FIRST, data);
 437                         else
 438                                 i2c_op(pd, OP_TX, data);
 439                         break;
 440                 }
 441
 442                 if (pd->pos == 0) {
 443                         i2c_op(pd, OP_TX_TO_RX, 0);
 444                         break;
 445                 }
 446
 447                 real_pos = pd->pos - 2;
 448
 449                 if (pd->pos == pd->msg->len) {
 450                         if (real_pos < 0) {
 451                                 i2c_op(pd, OP_RX_STOP, 0);
 452                                 break;
 453                         }
 454                         data = i2c_op(pd, OP_RX_STOP_DATA, 0);
 455                 } else
 456                         data = i2c_op(pd, OP_RX, 0);
 457
 458                 if (real_pos >= 0)
 459                         pd->msg->buf[real_pos] = data;
 460         } while (0);
 461
 462         pd->pos++;
 463         return pd->pos == (pd->msg->len + 2);
 464 }
 465
 466 static irqreturn_t sh_mobile_i2c_isr(int irq, void *dev_id)
 467 {
 468         struct platform_device *dev = dev_id;
 469         struct sh_mobile_i2c_data *pd = platform_get_drvdata(dev);
 470         unsigned char sr;
 471         int wakeup = 0;
 472
 473         sr = iic_rd(pd, ICSR);
 474         pd->sr |= sr; /* remember state */
 475
 476         dev_dbg(pd->dev, "i2c_isr 0x%02x 0x%02x %s %d %d!\n", sr, pd->sr,
 477                (pd->msg->flags & I2C_M_RD) ? "read" : "write",
 478                pd->pos, pd->msg->len);
 479
 480         /* Kick off TxDMA after preface was done */
 481         if (pd->dma_direction == DMA_TO_DEVICE && pd->pos == 0)
 482                 iic_set_clr(pd, ICIC, ICIC_TDMAE, 0);
 483         else if (sr & (ICSR_AL | ICSR_TACK))
 484                 /* don't interrupt transaction - continue to issue stop */
 485                 iic_wr(pd, ICSR, sr & ~(ICSR_AL | ICSR_TACK));
 486         else if (pd->msg->flags & I2C_M_RD)
 487                 wakeup = sh_mobile_i2c_isr_rx(pd);
 488         else
 489                 wakeup = sh_mobile_i2c_isr_tx(pd);
 490
 491         /* Kick off RxDMA after preface was done */
 492         if (pd->dma_direction == DMA_FROM_DEVICE && pd->pos == 1)
 493                 iic_set_clr(pd, ICIC, ICIC_RDMAE, 0);
 494
 495         if (sr & ICSR_WAIT) /* TODO: add delay here to support slow acks */
 496                 iic_wr(pd, ICSR, sr & ~ICSR_WAIT);
 497
 498         if (wakeup) {
 499                 pd->sr |= SW_DONE;
 500                 wake_up(&pd->wait);
 501         }
 502
 503         /* defeat write posting to avoid spurious WAIT interrupts */
 504         iic_rd(pd, ICSR);
 505
 506         return IRQ_HANDLED;
 507 }
 508
 509 static void sh_mobile_i2c_cleanup_dma(struct sh_mobile_i2c_data *pd)
 510 {
 511         if (pd->dma_direction == DMA_NONE)
 512                 return;
 513         else if (pd->dma_direction == DMA_FROM_DEVICE)
 514                 dmaengine_terminate_all(pd->dma_rx);
 515         else if (pd->dma_direction == DMA_TO_DEVICE)
 516                 dmaengine_terminate_all(pd->dma_tx);
 517
 518         dma_unmap_single(pd->dev, sg_dma_address(&pd->sg),
 519                          pd->msg->len, pd->dma_direction);
 520
 521         pd->dma_direction = DMA_NONE;
 522 }
 523
 524 static void sh_mobile_i2c_dma_callback(void *data)
 525 {
 526         struct sh_mobile_i2c_data *pd = data;
 527
 528         dma_unmap_single(pd->dev, sg_dma_address(&pd->sg),
 529                          pd->msg->len, pd->dma_direction);
 530
 531         pd->dma_direction = DMA_NONE;
 532         pd->pos = pd->msg->len;
 533
 534         iic_set_clr(pd, ICIC, 0, ICIC_TDMAE | ICIC_RDMAE);
 535 }
 536
 537 static void sh_mobile_i2c_xfer_dma(struct sh_mobile_i2c_data *pd)
 538 {
 539         bool read = pd->msg->flags & I2C_M_RD;
 540         enum dma_data_direction dir = read ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
 541         struct dma_chan *chan = read ? pd->dma_rx : pd->dma_tx;
 542         struct dma_async_tx_descriptor *txdesc;
 543         dma_addr_t dma_addr;
 544         dma_cookie_t cookie;
 545
 546         if (!chan)
 547                 return;
 548
 549         dma_addr = dma_map_single(pd->dev, pd->msg->buf, pd->msg->len, dir);
 550         if (dma_mapping_error(pd->dev, dma_addr)) {
 551                 dev_dbg(pd->dev, "dma map failed, using PIO\n");
 552                 return;
 553         }
 554
 555         sg_dma_len(&pd->sg) = pd->msg->len;
 556         sg_dma_address(&pd->sg) = dma_addr;
 557
 558         pd->dma_direction = dir;
 559
 560         txdesc = dmaengine_prep_slave_sg(chan, &pd->sg, 1,
 561                                          read ? DMA_DEV_TO_MEM : DMA_MEM_TO_DEV,
 562                                          DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 563         if (!txdesc) {
 564                 dev_dbg(pd->dev, "dma prep slave sg failed, using PIO\n");
 565                 sh_mobile_i2c_cleanup_dma(pd);
 566                 return;
 567         }
 568
 569         txdesc->callback = sh_mobile_i2c_dma_callback;
 570         txdesc->callback_param = pd;
 571
 572         cookie = dmaengine_submit(txdesc);
 573         if (dma_submit_error(cookie)) {
 574                 dev_dbg(pd->dev, "submitting dma failed, using PIO\n");
 575                 sh_mobile_i2c_cleanup_dma(pd);
 576                 return;
 577         }
 578
 579         dma_async_issue_pending(chan);
 580 }
 581
 582 static int start_ch(struct sh_mobile_i2c_data *pd, struct i2c_msg *usr_msg,
 583                     bool do_init)
 584 {
 585         if (usr_msg->len == 0 && (usr_msg->flags & I2C_M_RD)) {
 586                 dev_err(pd->dev, "Unsupported zero length i2c read\n");
 587                 return -EOPNOTSUPP;
 588         }
 589
 590         if (do_init) {
 591                 /* Initialize channel registers */
 592                 iic_set_clr(pd, ICCR, 0, ICCR_ICE);
 593
 594                 /* Enable channel and configure rx ack */
 595                 iic_set_clr(pd, ICCR, ICCR_ICE, 0);
 596
 597                 /* Set the clock */
 598                 iic_wr(pd, ICCL, pd->iccl & 0xff);
 599                 iic_wr(pd, ICCH, pd->icch & 0xff);
 600         }
 601
 602         pd->msg = usr_msg;
 603         pd->pos = -1;
 604         pd->sr = 0;
 605
 606         if (pd->msg->len > 8)
 607                 sh_mobile_i2c_xfer_dma(pd);
 608
 609         /* Enable all interrupts to begin with */
 610         iic_wr(pd, ICIC, ICIC_DTEE | ICIC_WAITE | ICIC_ALE | ICIC_TACKE);
 611         return 0;
 612 }
 613
 614 static int poll_dte(struct sh_mobile_i2c_data *pd)
 615 {
 616         int i;
 617
 618         for (i = 1000; i; i--) {
 619                 u_int8_t val = iic_rd(pd, ICSR);
 620
 621                 if (val & ICSR_DTE)
 622                         break;
 623
 624                 if (val & ICSR_TACK)
 625                         return -ENXIO;
 626
 627                 udelay(10);
 628         }
 629
 630         return i ? 0 : -ETIMEDOUT;
 631 }
 632
 633 static int poll_busy(struct sh_mobile_i2c_data *pd)
 634 {
 635         int i;
 636
 637         for (i = 1000; i; i--) {
 638                 u_int8_t val = iic_rd(pd, ICSR);
 639
 640                 dev_dbg(pd->dev, "val 0x%02x pd->sr 0x%02x\n", val, pd->sr);
 641
 642                 /* the interrupt handler may wake us up before the
 643                  * transfer is finished, so poll the hardware
 644                  * until we're done.
 645                  */
 646                 if (!(val & ICSR_BUSY)) {
 647                         /* handle missing acknowledge and arbitration lost */
 648                         val |= pd->sr;
 649                         if (val & ICSR_TACK)
 650                                 return -ENXIO;
 651                         if (val & ICSR_AL)
 652                                 return -EAGAIN;
 653                         break;
 654                 }
 655
 656                 udelay(10);
 657         }
 658
 659         return i ? 0 : -ETIMEDOUT;
 660 }
 661
 662 static int sh_mobile_i2c_xfer(struct i2c_adapter *adapter,
 663                               struct i2c_msg *msgs,
 664                               int num)
 665 {
 666         struct sh_mobile_i2c_data *pd = i2c_get_adapdata(adapter);
 667         struct i2c_msg  *msg;
 668         int err = 0;
 669         int i, k;
 670
 671         activate_ch(pd);
 672
 673         /* Process all messages */
 674         for (i = 0; i < num; i++) {
 675                 bool do_start = pd->send_stop || !i;
 676                 msg = &msgs[i];
 677                 pd->send_stop = i == num - 1 || msg->flags & I2C_M_STOP;
 678
 679                 err = start_ch(pd, msg, do_start);
 680                 if (err)
 681                         break;
 682
 683                 if (do_start)
 684                         i2c_op(pd, OP_START, 0);
 685
 686                 /* The interrupt handler takes care of the rest... */
 687                 k = wait_event_timeout(pd->wait,
 688                                        pd->sr & (ICSR_TACK | SW_DONE),
 689                                        5 * HZ);
 690                 if (!k) {
 691                         dev_err(pd->dev, "Transfer request timed out\n");
 692                         if (pd->dma_direction != DMA_NONE)
 693                                 sh_mobile_i2c_cleanup_dma(pd);
 694
 695                         err = -ETIMEDOUT;
 696                         break;
 697                 }
 698
 699                 if (pd->send_stop)
 700                         err = poll_busy(pd);
 701                 else
 702                         err = poll_dte(pd);
 703                 if (err < 0)
 704                         break;
 705         }
 706
 707         deactivate_ch(pd);
 708
 709         if (!err)
 710                 err = num;
 711         return err;
 712 }
 713
 714 static u32 sh_mobile_i2c_func(struct i2c_adapter *adapter)
 715 {
 716         return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL | I2C_FUNC_PROTOCOL_MANGLING;
 717 }
 718
 719 static struct i2c_algorithm sh_mobile_i2c_algorithm = {
 720         .functionality  = sh_mobile_i2c_func,
 721         .master_xfer    = sh_mobile_i2c_xfer,
 722 };
 723
 724 static const struct sh_mobile_dt_config default_dt_config = {
 725         .clks_per_count = 1,
 726 };
 727
 728 static const struct sh_mobile_dt_config fast_clock_dt_config = {
 729         .clks_per_count = 2,
 730 };
 731
 732 static const struct of_device_id sh_mobile_i2c_dt_ids[] = {
 733         { .compatible = "renesas,rmobile-iic", .data = &default_dt_config },
 734         { .compatible = "renesas,iic-r8a73a4", .data = &fast_clock_dt_config },
 735         { .compatible = "renesas,iic-r8a7790", .data = &fast_clock_dt_config },
 736         { .compatible = "renesas,iic-r8a7791", .data = &fast_clock_dt_config },
 737         { .compatible = "renesas,iic-r8a7792", .data = &fast_clock_dt_config },
 738         { .compatible = "renesas,iic-r8a7793", .data = &fast_clock_dt_config },
 739         { .compatible = "renesas,iic-r8a7794", .data = &fast_clock_dt_config },
 740         { .compatible = "renesas,iic-sh73a0", .data = &fast_clock_dt_config },
 741         {},
 742 };
 743 MODULE_DEVICE_TABLE(of, sh_mobile_i2c_dt_ids);
 744
 745 static int sh_mobile_i2c_request_dma_chan(struct device *dev, enum dma_transfer_direction dir,
 746                                           dma_addr_t port_addr, struct dma_chan **chan_ptr)
 747 {
 748         dma_cap_mask_t mask;
 749         struct dma_chan *chan;
 750         struct dma_slave_config cfg;
 751         char *chan_name = dir == DMA_MEM_TO_DEV ? "tx" : "rx";
 752         int ret;
 753
 754         dma_cap_zero(mask);
 755         dma_cap_set(DMA_SLAVE, mask);
 756         *chan_ptr = NULL;
 757
 758         chan = dma_request_slave_channel_reason(dev, chan_name);
 759         if (IS_ERR(chan)) {
 760                 ret = PTR_ERR(chan);
 761                 dev_dbg(dev, "request_channel failed for %s (%d)\n", chan_name, ret);
 762                 return ret;
 763         }
 764
 765         memset(&cfg, 0, sizeof(cfg));
 766         cfg.direction = dir;
 767         if (dir == DMA_MEM_TO_DEV) {
 768                 cfg.dst_addr = port_addr;
 769                 cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
 770         } else {
 771                 cfg.src_addr = port_addr;
 772                 cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
 773         }
 774
 775         ret = dmaengine_slave_config(chan, &cfg);
 776         if (ret) {
 777                 dev_dbg(dev, "slave_config failed for %s (%d)\n", chan_name, ret);
 778                 dma_release_channel(chan);
 779                 return ret;
 780         }
 781
 782         *chan_ptr = chan;
 783
 784         dev_dbg(dev, "got DMA channel for %s\n", chan_name);
 785         return 0;
 786 }
 787
 788 static void sh_mobile_i2c_release_dma(struct sh_mobile_i2c_data *pd)
 789 {
 790         if (pd->dma_tx) {
 791                 dma_release_channel(pd->dma_tx);
 792                 pd->dma_tx = NULL;
 793         }
 794
 795         if (pd->dma_rx) {
 796                 dma_release_channel(pd->dma_rx);
 797                 pd->dma_rx = NULL;
 798         }
 799 }
 800
 801 static int sh_mobile_i2c_hook_irqs(struct platform_device *dev)
 802 {
 803         struct resource *res;
 804         resource_size_t n;
 805         int k = 0, ret;
 806
 807         while ((res = platform_get_resource(dev, IORESOURCE_IRQ, k))) {
 808                 for (n = res->start; n <= res->end; n++) {
 809                         ret = devm_request_irq(&dev->dev, n, sh_mobile_i2c_isr,
 810                                           0, dev_name(&dev->dev), dev);
 811                         if (ret) {
 812                                 dev_err(&dev->dev, "cannot request IRQ %pa\n", &n);
 813                                 return ret;
 814                         }
 815                 }
 816                 k++;
 817         }
 818
 819         return k > 0 ? 0 : -ENOENT;
 820 }
 821
 822 static int sh_mobile_i2c_probe(struct platform_device *dev)
 823 {
 824         struct i2c_sh_mobile_platform_data *pdata = dev_get_platdata(&dev->dev);
 825         struct sh_mobile_i2c_data *pd;
 826         struct i2c_adapter *adap;
 827         struct resource *res;
 828         int ret;
 829         u32 bus_speed;
 830
 831         pd = devm_kzalloc(&dev->dev, sizeof(struct sh_mobile_i2c_data), GFP_KERNEL);
 832         if (!pd)
 833                 return -ENOMEM;
 834
 835         pd->clk = devm_clk_get(&dev->dev, NULL);
 836         if (IS_ERR(pd->clk)) {
 837                 dev_err(&dev->dev, "cannot get clock\n");
 838                 return PTR_ERR(pd->clk);
 839         }
 840
 841         ret = sh_mobile_i2c_hook_irqs(dev);
 842         if (ret)
 843                 return ret;
 844
 845         pd->dev = &dev->dev;
 846         platform_set_drvdata(dev, pd);
 847
 848         res = platform_get_resource(dev, IORESOURCE_MEM, 0);
 849
 850         pd->reg = devm_ioremap_resource(&dev->dev, res);
 851         if (IS_ERR(pd->reg))
 852                 return PTR_ERR(pd->reg);
 853
 854         /* Use platform data bus speed or STANDARD_MODE */
 855         ret = of_property_read_u32(dev->dev.of_node, "clock-frequency", &bus_speed);
 856         pd->bus_speed = ret ? STANDARD_MODE : bus_speed;
 857
 858         pd->clks_per_count = 1;
 859
 860         if (dev->dev.of_node) {
 861                 const struct of_device_id *match;
 862
 863                 match = of_match_device(sh_mobile_i2c_dt_ids, &dev->dev);
 864                 if (match) {
 865                         const struct sh_mobile_dt_config *config;
 866
 867                         config = match->data;
 868                         pd->clks_per_count = config->clks_per_count;
 869                 }
 870         } else {
 871                 if (pdata && pdata->bus_speed)
 872                         pd->bus_speed = pdata->bus_speed;
 873                 if (pdata && pdata->clks_per_count)
 874                         pd->clks_per_count = pdata->clks_per_count;
 875         }
 876
 877         /* The IIC blocks on SH-Mobile ARM processors
 878          * come with two new bits in ICIC.
 879          */
 880         if (resource_size(res) > 0x17)
 881                 pd->flags |= IIC_FLAG_HAS_ICIC67;
 882
 883         ret = sh_mobile_i2c_init(pd);
 884         if (ret)
 885                 return ret;
 886
 887         /* Init DMA */
 888         sg_init_table(&pd->sg, 1);
 889         pd->dma_direction = DMA_NONE;
 890         ret = sh_mobile_i2c_request_dma_chan(pd->dev, DMA_DEV_TO_MEM,
 891                                              res->start + ICDR, &pd->dma_rx);
 892         if (ret == -EPROBE_DEFER)
 893                 return ret;
 894
 895         ret = sh_mobile_i2c_request_dma_chan(pd->dev, DMA_MEM_TO_DEV,
 896                                              res->start + ICDR, &pd->dma_tx);
 897         if (ret == -EPROBE_DEFER) {
 898                 sh_mobile_i2c_release_dma(pd);
 899                 return ret;
 900         }
 901
 902         /* Enable Runtime PM for this device.
 903          *
 904          * Also tell the Runtime PM core to ignore children
 905          * for this device since it is valid for us to suspend
 906          * this I2C master driver even though the slave devices
 907          * on the I2C bus may not be suspended.
 908          *
 909          * The state of the I2C hardware bus is unaffected by
 910          * the Runtime PM state.
 911          */
 912         pm_suspend_ignore_children(&dev->dev, true);
 913         pm_runtime_enable(&dev->dev);
 914
 915         /* setup the private data */
 916         adap = &pd->adap;
 917         i2c_set_adapdata(adap, pd);
 918
 919         adap->owner = THIS_MODULE;
 920         adap->algo = &sh_mobile_i2c_algorithm;
 921         adap->dev.parent = &dev->dev;
 922         adap->retries = 5;
 923         adap->nr = dev->id;
 924         adap->dev.of_node = dev->dev.of_node;
 925
 926         strlcpy(adap->name, dev->name, sizeof(adap->name));
 927
 928         spin_lock_init(&pd->lock);
 929         init_waitqueue_head(&pd->wait);
 930
 931         ret = i2c_add_numbered_adapter(adap);
 932         if (ret < 0) {
 933                 sh_mobile_i2c_release_dma(pd);
 934                 dev_err(&dev->dev, "cannot add numbered adapter\n");
 935                 return ret;
 936         }
 937
 938         dev_info(&dev->dev,
 939                  "I2C adapter %d with bus speed %lu Hz (L/H=0x%x/0x%x)\n",
 940                  adap->nr, pd->bus_speed, pd->iccl, pd->icch);
 941
 942         return 0;
 943 }
 944
 945 static int sh_mobile_i2c_remove(struct platform_device *dev)
 946 {
 947         struct sh_mobile_i2c_data *pd = platform_get_drvdata(dev);
 948
 949         i2c_del_adapter(&pd->adap);
 950         sh_mobile_i2c_release_dma(pd);
 951         pm_runtime_disable(&dev->dev);
 952         return 0;
 953 }
 954
 955 static int sh_mobile_i2c_runtime_nop(struct device *dev)
 956 {
 957         /* Runtime PM callback shared between ->runtime_suspend()
 958          * and ->runtime_resume(). Simply returns success.
 959          *
 960          * This driver re-initializes all registers after
 961          * pm_runtime_get_sync() anyway so there is no need
 962          * to save and restore registers here.
 963          */
 964         return 0;
 965 }
 966
 967 static const struct dev_pm_ops sh_mobile_i2c_dev_pm_ops = {
 968         .runtime_suspend = sh_mobile_i2c_runtime_nop,
 969         .runtime_resume = sh_mobile_i2c_runtime_nop,
 970 };
 971
 972 static struct platform_driver sh_mobile_i2c_driver = {
 973         .driver         = {
 974                 .name           = "i2c-sh_mobile",
 975                 .owner          = THIS_MODULE,
 976                 .pm             = &sh_mobile_i2c_dev_pm_ops,
 977                 .of_match_table = sh_mobile_i2c_dt_ids,
 978         },
 979         .probe          = sh_mobile_i2c_probe,
 980         .remove         = sh_mobile_i2c_remove,
 981 };
 982
 983 static int __init sh_mobile_i2c_adap_init(void)
 984 {
 985         return platform_driver_register(&sh_mobile_i2c_driver);
 986 }
 987 subsys_initcall(sh_mobile_i2c_adap_init);
 988
 989 static void __exit sh_mobile_i2c_adap_exit(void)
 990 {
 991         platform_driver_unregister(&sh_mobile_i2c_driver);
 992 }
 993 module_exit(sh_mobile_i2c_adap_exit);
 994
 995 MODULE_DESCRIPTION("SuperH Mobile I2C Bus Controller driver");
 996 MODULE_AUTHOR("Magnus Damm and Wolfram Sang");
 997 MODULE_LICENSE("GPL v2");
 998 MODULE_ALIAS("platform:i2c-sh_mobile");