Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Freescale MXS I2C bus driver |
| 3 | * |
Wolfram Sang | 82fa63b | 2012-10-12 11:55:16 +0100 | [diff] [blame] | 4 | * Copyright (C) 2011-2012 Wolfram Sang, Pengutronix e.K. |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 5 | * |
| 6 | * based on a (non-working) driver which was: |
| 7 | * |
| 8 | * Copyright (C) 2009-2010 Freescale Semiconductor, Inc. All Rights Reserved. |
| 9 | * |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 10 | * This program is free software; you can redistribute it and/or modify |
| 11 | * it under the terms of the GNU General Public License as published by |
| 12 | * the Free Software Foundation; either version 2 of the License, or |
| 13 | * (at your option) any later version. |
| 14 | * |
| 15 | */ |
| 16 | |
| 17 | #include <linux/slab.h> |
| 18 | #include <linux/device.h> |
| 19 | #include <linux/module.h> |
| 20 | #include <linux/i2c.h> |
| 21 | #include <linux/err.h> |
| 22 | #include <linux/interrupt.h> |
| 23 | #include <linux/completion.h> |
| 24 | #include <linux/platform_device.h> |
| 25 | #include <linux/jiffies.h> |
| 26 | #include <linux/io.h> |
Shawn Guo | d98d033 | 2012-05-06 22:59:45 +0800 | [diff] [blame] | 27 | #include <linux/pinctrl/consumer.h> |
Wolfram Sang | 6b866c1 | 2011-08-31 20:37:50 +0200 | [diff] [blame] | 28 | #include <linux/stmp_device.h> |
Shawn Guo | b237866 | 2012-05-12 13:43:32 +0800 | [diff] [blame] | 29 | #include <linux/of.h> |
| 30 | #include <linux/of_device.h> |
| 31 | #include <linux/of_i2c.h> |
Marek Vasut | 62885f5 | 2012-08-24 05:44:31 +0200 | [diff] [blame] | 32 | #include <linux/dma-mapping.h> |
| 33 | #include <linux/dmaengine.h> |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 34 | |
| 35 | #define DRIVER_NAME "mxs-i2c" |
| 36 | |
| 37 | #define MXS_I2C_CTRL0 (0x00) |
| 38 | #define MXS_I2C_CTRL0_SET (0x04) |
| 39 | |
| 40 | #define MXS_I2C_CTRL0_SFTRST 0x80000000 |
Marek Vasut | fc91e40 | 2013-01-24 13:56:21 +0100 | [diff] [blame] | 41 | #define MXS_I2C_CTRL0_RUN 0x20000000 |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 42 | #define MXS_I2C_CTRL0_SEND_NAK_ON_LAST 0x02000000 |
| 43 | #define MXS_I2C_CTRL0_RETAIN_CLOCK 0x00200000 |
| 44 | #define MXS_I2C_CTRL0_POST_SEND_STOP 0x00100000 |
| 45 | #define MXS_I2C_CTRL0_PRE_SEND_START 0x00080000 |
| 46 | #define MXS_I2C_CTRL0_MASTER_MODE 0x00020000 |
| 47 | #define MXS_I2C_CTRL0_DIRECTION 0x00010000 |
| 48 | #define MXS_I2C_CTRL0_XFER_COUNT(v) ((v) & 0x0000FFFF) |
| 49 | |
Marek Vasut | cd4f2d4 | 2012-07-09 18:22:53 +0200 | [diff] [blame] | 50 | #define MXS_I2C_TIMING0 (0x10) |
| 51 | #define MXS_I2C_TIMING1 (0x20) |
| 52 | #define MXS_I2C_TIMING2 (0x30) |
| 53 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 54 | #define MXS_I2C_CTRL1 (0x40) |
| 55 | #define MXS_I2C_CTRL1_SET (0x44) |
| 56 | #define MXS_I2C_CTRL1_CLR (0x48) |
| 57 | |
| 58 | #define MXS_I2C_CTRL1_BUS_FREE_IRQ 0x80 |
| 59 | #define MXS_I2C_CTRL1_DATA_ENGINE_CMPLT_IRQ 0x40 |
| 60 | #define MXS_I2C_CTRL1_NO_SLAVE_ACK_IRQ 0x20 |
| 61 | #define MXS_I2C_CTRL1_OVERSIZE_XFER_TERM_IRQ 0x10 |
| 62 | #define MXS_I2C_CTRL1_EARLY_TERM_IRQ 0x08 |
| 63 | #define MXS_I2C_CTRL1_MASTER_LOSS_IRQ 0x04 |
| 64 | #define MXS_I2C_CTRL1_SLAVE_STOP_IRQ 0x02 |
| 65 | #define MXS_I2C_CTRL1_SLAVE_IRQ 0x01 |
| 66 | |
Marek Vasut | fc91e40 | 2013-01-24 13:56:21 +0100 | [diff] [blame] | 67 | #define MXS_I2C_DATA (0xa0) |
| 68 | |
| 69 | #define MXS_I2C_DEBUG0 (0xb0) |
| 70 | #define MXS_I2C_DEBUG0_CLR (0xb8) |
| 71 | |
| 72 | #define MXS_I2C_DEBUG0_DMAREQ 0x80000000 |
| 73 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 74 | #define MXS_I2C_IRQ_MASK (MXS_I2C_CTRL1_DATA_ENGINE_CMPLT_IRQ | \ |
| 75 | MXS_I2C_CTRL1_NO_SLAVE_ACK_IRQ | \ |
| 76 | MXS_I2C_CTRL1_EARLY_TERM_IRQ | \ |
| 77 | MXS_I2C_CTRL1_MASTER_LOSS_IRQ | \ |
| 78 | MXS_I2C_CTRL1_SLAVE_STOP_IRQ | \ |
| 79 | MXS_I2C_CTRL1_SLAVE_IRQ) |
| 80 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 81 | |
| 82 | #define MXS_CMD_I2C_SELECT (MXS_I2C_CTRL0_RETAIN_CLOCK | \ |
| 83 | MXS_I2C_CTRL0_PRE_SEND_START | \ |
| 84 | MXS_I2C_CTRL0_MASTER_MODE | \ |
| 85 | MXS_I2C_CTRL0_DIRECTION | \ |
| 86 | MXS_I2C_CTRL0_XFER_COUNT(1)) |
| 87 | |
| 88 | #define MXS_CMD_I2C_WRITE (MXS_I2C_CTRL0_PRE_SEND_START | \ |
| 89 | MXS_I2C_CTRL0_MASTER_MODE | \ |
| 90 | MXS_I2C_CTRL0_DIRECTION) |
| 91 | |
| 92 | #define MXS_CMD_I2C_READ (MXS_I2C_CTRL0_SEND_NAK_ON_LAST | \ |
| 93 | MXS_I2C_CTRL0_MASTER_MODE) |
| 94 | |
| 95 | /** |
| 96 | * struct mxs_i2c_dev - per device, private MXS-I2C data |
| 97 | * |
| 98 | * @dev: driver model device node |
| 99 | * @regs: IO registers pointer |
| 100 | * @cmd_complete: completion object for transaction wait |
| 101 | * @cmd_err: error code for last transaction |
| 102 | * @adapter: i2c subsystem adapter node |
| 103 | */ |
| 104 | struct mxs_i2c_dev { |
| 105 | struct device *dev; |
| 106 | void __iomem *regs; |
| 107 | struct completion cmd_complete; |
Fabio Estevam | 0f40cbc | 2013-01-07 22:32:06 -0200 | [diff] [blame] | 108 | int cmd_err; |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 109 | struct i2c_adapter adapter; |
Marek Vasut | 626f0a2 | 2012-11-30 18:48:35 +0100 | [diff] [blame] | 110 | |
| 111 | uint32_t timing0; |
| 112 | uint32_t timing1; |
Marek Vasut | 62885f5 | 2012-08-24 05:44:31 +0200 | [diff] [blame] | 113 | |
| 114 | /* DMA support components */ |
Marek Vasut | 62885f5 | 2012-08-24 05:44:31 +0200 | [diff] [blame] | 115 | struct dma_chan *dmach; |
Marek Vasut | 62885f5 | 2012-08-24 05:44:31 +0200 | [diff] [blame] | 116 | uint32_t pio_data[2]; |
| 117 | uint32_t addr_data; |
| 118 | struct scatterlist sg_io[2]; |
| 119 | bool dma_read; |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 120 | }; |
| 121 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 122 | static void mxs_i2c_reset(struct mxs_i2c_dev *i2c) |
| 123 | { |
Wolfram Sang | 6b866c1 | 2011-08-31 20:37:50 +0200 | [diff] [blame] | 124 | stmp_reset_block(i2c->regs); |
Marek Vasut | cd4f2d4 | 2012-07-09 18:22:53 +0200 | [diff] [blame] | 125 | |
Marek Vasut | 626f0a2 | 2012-11-30 18:48:35 +0100 | [diff] [blame] | 126 | /* |
| 127 | * Configure timing for the I2C block. The I2C TIMING2 register has to |
| 128 | * be programmed with this particular magic number. The rest is derived |
| 129 | * from the XTAL speed and requested I2C speed. |
| 130 | * |
| 131 | * For details, see i.MX233 [25.4.2 - 25.4.4] and i.MX28 [27.5.2 - 27.5.4]. |
| 132 | */ |
| 133 | writel(i2c->timing0, i2c->regs + MXS_I2C_TIMING0); |
| 134 | writel(i2c->timing1, i2c->regs + MXS_I2C_TIMING1); |
| 135 | writel(0x00300030, i2c->regs + MXS_I2C_TIMING2); |
Marek Vasut | cd4f2d4 | 2012-07-09 18:22:53 +0200 | [diff] [blame] | 136 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 137 | writel(MXS_I2C_IRQ_MASK << 8, i2c->regs + MXS_I2C_CTRL1_SET); |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 138 | } |
| 139 | |
Marek Vasut | 62885f5 | 2012-08-24 05:44:31 +0200 | [diff] [blame] | 140 | static void mxs_i2c_dma_finish(struct mxs_i2c_dev *i2c) |
| 141 | { |
| 142 | if (i2c->dma_read) { |
| 143 | dma_unmap_sg(i2c->dev, &i2c->sg_io[0], 1, DMA_TO_DEVICE); |
| 144 | dma_unmap_sg(i2c->dev, &i2c->sg_io[1], 1, DMA_FROM_DEVICE); |
| 145 | } else { |
| 146 | dma_unmap_sg(i2c->dev, i2c->sg_io, 2, DMA_TO_DEVICE); |
| 147 | } |
| 148 | } |
| 149 | |
| 150 | static void mxs_i2c_dma_irq_callback(void *param) |
| 151 | { |
| 152 | struct mxs_i2c_dev *i2c = param; |
| 153 | |
| 154 | complete(&i2c->cmd_complete); |
| 155 | mxs_i2c_dma_finish(i2c); |
| 156 | } |
| 157 | |
| 158 | static int mxs_i2c_dma_setup_xfer(struct i2c_adapter *adap, |
| 159 | struct i2c_msg *msg, uint32_t flags) |
| 160 | { |
| 161 | struct dma_async_tx_descriptor *desc; |
| 162 | struct mxs_i2c_dev *i2c = i2c_get_adapdata(adap); |
| 163 | |
| 164 | if (msg->flags & I2C_M_RD) { |
| 165 | i2c->dma_read = 1; |
| 166 | i2c->addr_data = (msg->addr << 1) | I2C_SMBUS_READ; |
| 167 | |
| 168 | /* |
| 169 | * SELECT command. |
| 170 | */ |
| 171 | |
| 172 | /* Queue the PIO register write transfer. */ |
| 173 | i2c->pio_data[0] = MXS_CMD_I2C_SELECT; |
| 174 | desc = dmaengine_prep_slave_sg(i2c->dmach, |
| 175 | (struct scatterlist *)&i2c->pio_data[0], |
| 176 | 1, DMA_TRANS_NONE, 0); |
| 177 | if (!desc) { |
| 178 | dev_err(i2c->dev, |
| 179 | "Failed to get PIO reg. write descriptor.\n"); |
| 180 | goto select_init_pio_fail; |
| 181 | } |
| 182 | |
| 183 | /* Queue the DMA data transfer. */ |
| 184 | sg_init_one(&i2c->sg_io[0], &i2c->addr_data, 1); |
| 185 | dma_map_sg(i2c->dev, &i2c->sg_io[0], 1, DMA_TO_DEVICE); |
| 186 | desc = dmaengine_prep_slave_sg(i2c->dmach, &i2c->sg_io[0], 1, |
| 187 | DMA_MEM_TO_DEV, |
| 188 | DMA_PREP_INTERRUPT | DMA_CTRL_ACK); |
| 189 | if (!desc) { |
| 190 | dev_err(i2c->dev, |
| 191 | "Failed to get DMA data write descriptor.\n"); |
| 192 | goto select_init_dma_fail; |
| 193 | } |
| 194 | |
| 195 | /* |
| 196 | * READ command. |
| 197 | */ |
| 198 | |
| 199 | /* Queue the PIO register write transfer. */ |
| 200 | i2c->pio_data[1] = flags | MXS_CMD_I2C_READ | |
| 201 | MXS_I2C_CTRL0_XFER_COUNT(msg->len); |
| 202 | desc = dmaengine_prep_slave_sg(i2c->dmach, |
| 203 | (struct scatterlist *)&i2c->pio_data[1], |
| 204 | 1, DMA_TRANS_NONE, DMA_PREP_INTERRUPT); |
| 205 | if (!desc) { |
| 206 | dev_err(i2c->dev, |
| 207 | "Failed to get PIO reg. write descriptor.\n"); |
| 208 | goto select_init_dma_fail; |
| 209 | } |
| 210 | |
| 211 | /* Queue the DMA data transfer. */ |
| 212 | sg_init_one(&i2c->sg_io[1], msg->buf, msg->len); |
| 213 | dma_map_sg(i2c->dev, &i2c->sg_io[1], 1, DMA_FROM_DEVICE); |
| 214 | desc = dmaengine_prep_slave_sg(i2c->dmach, &i2c->sg_io[1], 1, |
| 215 | DMA_DEV_TO_MEM, |
| 216 | DMA_PREP_INTERRUPT | DMA_CTRL_ACK); |
| 217 | if (!desc) { |
| 218 | dev_err(i2c->dev, |
| 219 | "Failed to get DMA data write descriptor.\n"); |
| 220 | goto read_init_dma_fail; |
| 221 | } |
| 222 | } else { |
| 223 | i2c->dma_read = 0; |
| 224 | i2c->addr_data = (msg->addr << 1) | I2C_SMBUS_WRITE; |
| 225 | |
| 226 | /* |
| 227 | * WRITE command. |
| 228 | */ |
| 229 | |
| 230 | /* Queue the PIO register write transfer. */ |
| 231 | i2c->pio_data[0] = flags | MXS_CMD_I2C_WRITE | |
| 232 | MXS_I2C_CTRL0_XFER_COUNT(msg->len + 1); |
| 233 | desc = dmaengine_prep_slave_sg(i2c->dmach, |
| 234 | (struct scatterlist *)&i2c->pio_data[0], |
| 235 | 1, DMA_TRANS_NONE, 0); |
| 236 | if (!desc) { |
| 237 | dev_err(i2c->dev, |
| 238 | "Failed to get PIO reg. write descriptor.\n"); |
| 239 | goto write_init_pio_fail; |
| 240 | } |
| 241 | |
| 242 | /* Queue the DMA data transfer. */ |
| 243 | sg_init_table(i2c->sg_io, 2); |
| 244 | sg_set_buf(&i2c->sg_io[0], &i2c->addr_data, 1); |
| 245 | sg_set_buf(&i2c->sg_io[1], msg->buf, msg->len); |
| 246 | dma_map_sg(i2c->dev, i2c->sg_io, 2, DMA_TO_DEVICE); |
| 247 | desc = dmaengine_prep_slave_sg(i2c->dmach, i2c->sg_io, 2, |
| 248 | DMA_MEM_TO_DEV, |
| 249 | DMA_PREP_INTERRUPT | DMA_CTRL_ACK); |
| 250 | if (!desc) { |
| 251 | dev_err(i2c->dev, |
| 252 | "Failed to get DMA data write descriptor.\n"); |
| 253 | goto write_init_dma_fail; |
| 254 | } |
| 255 | } |
| 256 | |
| 257 | /* |
| 258 | * The last descriptor must have this callback, |
| 259 | * to finish the DMA transaction. |
| 260 | */ |
| 261 | desc->callback = mxs_i2c_dma_irq_callback; |
| 262 | desc->callback_param = i2c; |
| 263 | |
| 264 | /* Start the transfer. */ |
| 265 | dmaengine_submit(desc); |
| 266 | dma_async_issue_pending(i2c->dmach); |
| 267 | return 0; |
| 268 | |
| 269 | /* Read failpath. */ |
| 270 | read_init_dma_fail: |
| 271 | dma_unmap_sg(i2c->dev, &i2c->sg_io[1], 1, DMA_FROM_DEVICE); |
| 272 | select_init_dma_fail: |
| 273 | dma_unmap_sg(i2c->dev, &i2c->sg_io[0], 1, DMA_TO_DEVICE); |
| 274 | select_init_pio_fail: |
Marek Vasut | c35d3cf | 2012-11-18 06:25:07 +0100 | [diff] [blame] | 275 | dmaengine_terminate_all(i2c->dmach); |
Marek Vasut | 62885f5 | 2012-08-24 05:44:31 +0200 | [diff] [blame] | 276 | return -EINVAL; |
| 277 | |
| 278 | /* Write failpath. */ |
| 279 | write_init_dma_fail: |
| 280 | dma_unmap_sg(i2c->dev, i2c->sg_io, 2, DMA_TO_DEVICE); |
| 281 | write_init_pio_fail: |
Marek Vasut | c35d3cf | 2012-11-18 06:25:07 +0100 | [diff] [blame] | 282 | dmaengine_terminate_all(i2c->dmach); |
Marek Vasut | 62885f5 | 2012-08-24 05:44:31 +0200 | [diff] [blame] | 283 | return -EINVAL; |
| 284 | } |
| 285 | |
Marek Vasut | fc91e40 | 2013-01-24 13:56:21 +0100 | [diff] [blame] | 286 | static int mxs_i2c_pio_wait_dmareq(struct mxs_i2c_dev *i2c) |
| 287 | { |
| 288 | unsigned long timeout = jiffies + msecs_to_jiffies(1000); |
| 289 | |
| 290 | while (!(readl(i2c->regs + MXS_I2C_DEBUG0) & |
| 291 | MXS_I2C_DEBUG0_DMAREQ)) { |
| 292 | if (time_after(jiffies, timeout)) |
| 293 | return -ETIMEDOUT; |
| 294 | cond_resched(); |
| 295 | } |
| 296 | |
| 297 | writel(MXS_I2C_DEBUG0_DMAREQ, i2c->regs + MXS_I2C_DEBUG0_CLR); |
| 298 | |
| 299 | return 0; |
| 300 | } |
| 301 | |
| 302 | static int mxs_i2c_pio_wait_cplt(struct mxs_i2c_dev *i2c) |
| 303 | { |
| 304 | unsigned long timeout = jiffies + msecs_to_jiffies(1000); |
| 305 | |
| 306 | /* |
| 307 | * We do not use interrupts in the PIO mode. Due to the |
| 308 | * maximum transfer length being 8 bytes in PIO mode, the |
| 309 | * overhead of interrupt would be too large and this would |
| 310 | * neglect the gain from using the PIO mode. |
| 311 | */ |
| 312 | |
| 313 | while (!(readl(i2c->regs + MXS_I2C_CTRL1) & |
| 314 | MXS_I2C_CTRL1_DATA_ENGINE_CMPLT_IRQ)) { |
| 315 | if (time_after(jiffies, timeout)) |
| 316 | return -ETIMEDOUT; |
| 317 | cond_resched(); |
| 318 | } |
| 319 | |
| 320 | writel(MXS_I2C_CTRL1_DATA_ENGINE_CMPLT_IRQ, |
| 321 | i2c->regs + MXS_I2C_CTRL1_CLR); |
| 322 | |
| 323 | return 0; |
| 324 | } |
| 325 | |
| 326 | static int mxs_i2c_pio_setup_xfer(struct i2c_adapter *adap, |
| 327 | struct i2c_msg *msg, uint32_t flags) |
| 328 | { |
| 329 | struct mxs_i2c_dev *i2c = i2c_get_adapdata(adap); |
| 330 | uint32_t addr_data = msg->addr << 1; |
| 331 | uint32_t data = 0; |
| 332 | int i, shifts_left, ret; |
| 333 | |
| 334 | /* Mute IRQs coming from this block. */ |
| 335 | writel(MXS_I2C_IRQ_MASK << 8, i2c->regs + MXS_I2C_CTRL1_CLR); |
| 336 | |
| 337 | if (msg->flags & I2C_M_RD) { |
| 338 | addr_data |= I2C_SMBUS_READ; |
| 339 | |
| 340 | /* SELECT command. */ |
| 341 | writel(MXS_I2C_CTRL0_RUN | MXS_CMD_I2C_SELECT, |
| 342 | i2c->regs + MXS_I2C_CTRL0); |
| 343 | |
| 344 | ret = mxs_i2c_pio_wait_dmareq(i2c); |
| 345 | if (ret) |
| 346 | return ret; |
| 347 | |
| 348 | writel(addr_data, i2c->regs + MXS_I2C_DATA); |
| 349 | |
| 350 | ret = mxs_i2c_pio_wait_cplt(i2c); |
| 351 | if (ret) |
| 352 | return ret; |
| 353 | |
| 354 | /* READ command. */ |
| 355 | writel(MXS_I2C_CTRL0_RUN | MXS_CMD_I2C_READ | flags | |
| 356 | MXS_I2C_CTRL0_XFER_COUNT(msg->len), |
| 357 | i2c->regs + MXS_I2C_CTRL0); |
| 358 | |
| 359 | for (i = 0; i < msg->len; i++) { |
| 360 | if ((i & 3) == 0) { |
| 361 | ret = mxs_i2c_pio_wait_dmareq(i2c); |
| 362 | if (ret) |
| 363 | return ret; |
| 364 | data = readl(i2c->regs + MXS_I2C_DATA); |
| 365 | } |
| 366 | msg->buf[i] = data & 0xff; |
| 367 | data >>= 8; |
| 368 | } |
| 369 | } else { |
| 370 | addr_data |= I2C_SMBUS_WRITE; |
| 371 | |
| 372 | /* WRITE command. */ |
| 373 | writel(MXS_I2C_CTRL0_RUN | MXS_CMD_I2C_WRITE | flags | |
| 374 | MXS_I2C_CTRL0_XFER_COUNT(msg->len + 1), |
| 375 | i2c->regs + MXS_I2C_CTRL0); |
| 376 | |
| 377 | /* |
| 378 | * The LSB of data buffer is the first byte blasted across |
| 379 | * the bus. Higher order bytes follow. Thus the following |
| 380 | * filling schematic. |
| 381 | */ |
| 382 | data = addr_data << 24; |
| 383 | for (i = 0; i < msg->len; i++) { |
| 384 | data >>= 8; |
| 385 | data |= (msg->buf[i] << 24); |
| 386 | if ((i & 3) == 2) { |
| 387 | ret = mxs_i2c_pio_wait_dmareq(i2c); |
| 388 | if (ret) |
| 389 | return ret; |
| 390 | writel(data, i2c->regs + MXS_I2C_DATA); |
| 391 | } |
| 392 | } |
| 393 | |
| 394 | shifts_left = 24 - (i & 3) * 8; |
| 395 | if (shifts_left) { |
| 396 | data >>= shifts_left; |
| 397 | ret = mxs_i2c_pio_wait_dmareq(i2c); |
| 398 | if (ret) |
| 399 | return ret; |
| 400 | writel(data, i2c->regs + MXS_I2C_DATA); |
| 401 | } |
| 402 | } |
| 403 | |
| 404 | ret = mxs_i2c_pio_wait_cplt(i2c); |
| 405 | if (ret) |
| 406 | return ret; |
| 407 | |
| 408 | /* Clear any dangling IRQs and re-enable interrupts. */ |
| 409 | writel(MXS_I2C_IRQ_MASK, i2c->regs + MXS_I2C_CTRL1_CLR); |
| 410 | writel(MXS_I2C_IRQ_MASK << 8, i2c->regs + MXS_I2C_CTRL1_SET); |
| 411 | |
| 412 | return 0; |
| 413 | } |
| 414 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 415 | /* |
| 416 | * Low level master read/write transaction. |
| 417 | */ |
| 418 | static int mxs_i2c_xfer_msg(struct i2c_adapter *adap, struct i2c_msg *msg, |
| 419 | int stop) |
| 420 | { |
| 421 | struct mxs_i2c_dev *i2c = i2c_get_adapdata(adap); |
| 422 | int ret; |
| 423 | int flags; |
| 424 | |
Marek Vasut | 62885f5 | 2012-08-24 05:44:31 +0200 | [diff] [blame] | 425 | flags = stop ? MXS_I2C_CTRL0_POST_SEND_STOP : 0; |
| 426 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 427 | dev_dbg(i2c->dev, "addr: 0x%04x, len: %d, flags: 0x%x, stop: %d\n", |
| 428 | msg->addr, msg->len, msg->flags, stop); |
| 429 | |
| 430 | if (msg->len == 0) |
| 431 | return -EINVAL; |
| 432 | |
Marek Vasut | fc91e40 | 2013-01-24 13:56:21 +0100 | [diff] [blame] | 433 | /* |
| 434 | * The current boundary to select between PIO/DMA transfer method |
| 435 | * is set to 8 bytes, transfers shorter than 8 bytes are transfered |
| 436 | * using PIO mode while longer transfers use DMA. The 8 byte border is |
| 437 | * based on this empirical measurement and a lot of previous frobbing. |
| 438 | */ |
| 439 | if (msg->len < 8) { |
| 440 | ret = mxs_i2c_pio_setup_xfer(adap, msg, flags); |
| 441 | if (ret) |
| 442 | mxs_i2c_reset(i2c); |
| 443 | } else { |
| 444 | i2c->cmd_err = 0; |
| 445 | INIT_COMPLETION(i2c->cmd_complete); |
| 446 | ret = mxs_i2c_dma_setup_xfer(adap, msg, flags); |
| 447 | if (ret) |
| 448 | return ret; |
Wolfram Sang | 844990d | 2012-01-13 12:14:26 +0100 | [diff] [blame] | 449 | |
Marek Vasut | fc91e40 | 2013-01-24 13:56:21 +0100 | [diff] [blame] | 450 | ret = wait_for_completion_timeout(&i2c->cmd_complete, |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 451 | msecs_to_jiffies(1000)); |
Marek Vasut | fc91e40 | 2013-01-24 13:56:21 +0100 | [diff] [blame] | 452 | if (ret == 0) |
| 453 | goto timeout; |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 454 | |
Marek Vasut | fc91e40 | 2013-01-24 13:56:21 +0100 | [diff] [blame] | 455 | if (i2c->cmd_err == -ENXIO) |
| 456 | mxs_i2c_reset(i2c); |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 457 | |
Marek Vasut | fc91e40 | 2013-01-24 13:56:21 +0100 | [diff] [blame] | 458 | ret = i2c->cmd_err; |
| 459 | } |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 460 | |
Marek Vasut | fc91e40 | 2013-01-24 13:56:21 +0100 | [diff] [blame] | 461 | dev_dbg(i2c->dev, "Done with err=%d\n", ret); |
| 462 | |
| 463 | return ret; |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 464 | |
| 465 | timeout: |
| 466 | dev_dbg(i2c->dev, "Timeout!\n"); |
Wolfram Sang | 82fa63b | 2012-10-12 11:55:16 +0100 | [diff] [blame] | 467 | mxs_i2c_dma_finish(i2c); |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 468 | mxs_i2c_reset(i2c); |
| 469 | return -ETIMEDOUT; |
| 470 | } |
| 471 | |
| 472 | static int mxs_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], |
| 473 | int num) |
| 474 | { |
| 475 | int i; |
| 476 | int err; |
| 477 | |
| 478 | for (i = 0; i < num; i++) { |
| 479 | err = mxs_i2c_xfer_msg(adap, &msgs[i], i == (num - 1)); |
| 480 | if (err) |
| 481 | return err; |
| 482 | } |
| 483 | |
| 484 | return num; |
| 485 | } |
| 486 | |
| 487 | static u32 mxs_i2c_func(struct i2c_adapter *adap) |
| 488 | { |
Marek Vasut | 8f41405 | 2012-11-18 06:25:08 +0100 | [diff] [blame] | 489 | return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL; |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 490 | } |
| 491 | |
| 492 | static irqreturn_t mxs_i2c_isr(int this_irq, void *dev_id) |
| 493 | { |
| 494 | struct mxs_i2c_dev *i2c = dev_id; |
| 495 | u32 stat = readl(i2c->regs + MXS_I2C_CTRL1) & MXS_I2C_IRQ_MASK; |
| 496 | |
| 497 | if (!stat) |
| 498 | return IRQ_NONE; |
| 499 | |
| 500 | if (stat & MXS_I2C_CTRL1_NO_SLAVE_ACK_IRQ) |
| 501 | i2c->cmd_err = -ENXIO; |
| 502 | else if (stat & (MXS_I2C_CTRL1_EARLY_TERM_IRQ | |
| 503 | MXS_I2C_CTRL1_MASTER_LOSS_IRQ | |
| 504 | MXS_I2C_CTRL1_SLAVE_STOP_IRQ | MXS_I2C_CTRL1_SLAVE_IRQ)) |
| 505 | /* MXS_I2C_CTRL1_OVERSIZE_XFER_TERM_IRQ is only for slaves */ |
| 506 | i2c->cmd_err = -EIO; |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 507 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 508 | writel(stat, i2c->regs + MXS_I2C_CTRL1_CLR); |
Wolfram Sang | 844990d | 2012-01-13 12:14:26 +0100 | [diff] [blame] | 509 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 510 | return IRQ_HANDLED; |
| 511 | } |
| 512 | |
| 513 | static const struct i2c_algorithm mxs_i2c_algo = { |
| 514 | .master_xfer = mxs_i2c_xfer, |
| 515 | .functionality = mxs_i2c_func, |
| 516 | }; |
| 517 | |
Marek Vasut | 626f0a2 | 2012-11-30 18:48:35 +0100 | [diff] [blame] | 518 | static void mxs_i2c_derive_timing(struct mxs_i2c_dev *i2c, int speed) |
| 519 | { |
| 520 | /* The I2C block clock run at 24MHz */ |
| 521 | const uint32_t clk = 24000000; |
| 522 | uint32_t base; |
| 523 | uint16_t high_count, low_count, rcv_count, xmit_count; |
| 524 | struct device *dev = i2c->dev; |
| 525 | |
| 526 | if (speed > 540000) { |
| 527 | dev_warn(dev, "Speed too high (%d Hz), using 540 kHz\n", speed); |
| 528 | speed = 540000; |
| 529 | } else if (speed < 12000) { |
| 530 | dev_warn(dev, "Speed too low (%d Hz), using 12 kHz\n", speed); |
| 531 | speed = 12000; |
| 532 | } |
| 533 | |
| 534 | /* |
| 535 | * The timing derivation algorithm. There is no documentation for this |
| 536 | * algorithm available, it was derived by using the scope and fiddling |
| 537 | * with constants until the result observed on the scope was good enough |
| 538 | * for 20kHz, 50kHz, 100kHz, 200kHz, 300kHz and 400kHz. It should be |
| 539 | * possible to assume the algorithm works for other frequencies as well. |
| 540 | * |
| 541 | * Note it was necessary to cap the frequency on both ends as it's not |
| 542 | * possible to configure completely arbitrary frequency for the I2C bus |
| 543 | * clock. |
| 544 | */ |
| 545 | base = ((clk / speed) - 38) / 2; |
| 546 | high_count = base + 3; |
| 547 | low_count = base - 3; |
| 548 | rcv_count = (high_count * 3) / 4; |
| 549 | xmit_count = low_count / 4; |
| 550 | |
| 551 | i2c->timing0 = (high_count << 16) | rcv_count; |
| 552 | i2c->timing1 = (low_count << 16) | xmit_count; |
| 553 | } |
| 554 | |
Marek Vasut | cd4f2d4 | 2012-07-09 18:22:53 +0200 | [diff] [blame] | 555 | static int mxs_i2c_get_ofdata(struct mxs_i2c_dev *i2c) |
| 556 | { |
| 557 | uint32_t speed; |
| 558 | struct device *dev = i2c->dev; |
| 559 | struct device_node *node = dev->of_node; |
| 560 | int ret; |
| 561 | |
Marek Vasut | cd4f2d4 | 2012-07-09 18:22:53 +0200 | [diff] [blame] | 562 | ret = of_property_read_u32(node, "clock-frequency", &speed); |
Marek Vasut | 626f0a2 | 2012-11-30 18:48:35 +0100 | [diff] [blame] | 563 | if (ret) { |
Marek Vasut | cd4f2d4 | 2012-07-09 18:22:53 +0200 | [diff] [blame] | 564 | dev_warn(dev, "No I2C speed selected, using 100kHz\n"); |
Marek Vasut | 626f0a2 | 2012-11-30 18:48:35 +0100 | [diff] [blame] | 565 | speed = 100000; |
| 566 | } |
| 567 | |
| 568 | mxs_i2c_derive_timing(i2c, speed); |
Marek Vasut | cd4f2d4 | 2012-07-09 18:22:53 +0200 | [diff] [blame] | 569 | |
| 570 | return 0; |
| 571 | } |
| 572 | |
Bill Pemberton | 0b255e9 | 2012-11-27 15:59:38 -0500 | [diff] [blame] | 573 | static int mxs_i2c_probe(struct platform_device *pdev) |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 574 | { |
| 575 | struct device *dev = &pdev->dev; |
| 576 | struct mxs_i2c_dev *i2c; |
| 577 | struct i2c_adapter *adap; |
Shawn Guo | d98d033 | 2012-05-06 22:59:45 +0800 | [diff] [blame] | 578 | struct pinctrl *pinctrl; |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 579 | struct resource *res; |
| 580 | resource_size_t res_size; |
Shawn Guo | e5aba13 | 2013-02-26 11:20:22 +0800 | [diff] [blame^] | 581 | int err, irq; |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 582 | |
Shawn Guo | d98d033 | 2012-05-06 22:59:45 +0800 | [diff] [blame] | 583 | pinctrl = devm_pinctrl_get_select_default(dev); |
| 584 | if (IS_ERR(pinctrl)) |
| 585 | return PTR_ERR(pinctrl); |
| 586 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 587 | i2c = devm_kzalloc(dev, sizeof(struct mxs_i2c_dev), GFP_KERNEL); |
| 588 | if (!i2c) |
| 589 | return -ENOMEM; |
| 590 | |
| 591 | res = platform_get_resource(pdev, IORESOURCE_MEM, 0); |
Marek Vasut | 62885f5 | 2012-08-24 05:44:31 +0200 | [diff] [blame] | 592 | irq = platform_get_irq(pdev, 0); |
Marek Vasut | 62885f5 | 2012-08-24 05:44:31 +0200 | [diff] [blame] | 593 | |
Shawn Guo | e5aba13 | 2013-02-26 11:20:22 +0800 | [diff] [blame^] | 594 | if (!res || irq < 0) |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 595 | return -ENOENT; |
| 596 | |
| 597 | res_size = resource_size(res); |
| 598 | if (!devm_request_mem_region(dev, res->start, res_size, res->name)) |
| 599 | return -EBUSY; |
| 600 | |
| 601 | i2c->regs = devm_ioremap_nocache(dev, res->start, res_size); |
| 602 | if (!i2c->regs) |
| 603 | return -EBUSY; |
| 604 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 605 | err = devm_request_irq(dev, irq, mxs_i2c_isr, 0, dev_name(dev), i2c); |
| 606 | if (err) |
| 607 | return err; |
| 608 | |
| 609 | i2c->dev = dev; |
Marek Vasut | cd4f2d4 | 2012-07-09 18:22:53 +0200 | [diff] [blame] | 610 | |
Marek Vasut | 85de7fa | 2012-11-21 06:19:06 +0100 | [diff] [blame] | 611 | init_completion(&i2c->cmd_complete); |
| 612 | |
Wolfram Sang | 72ee734 | 2012-09-08 17:28:06 +0200 | [diff] [blame] | 613 | if (dev->of_node) { |
| 614 | err = mxs_i2c_get_ofdata(i2c); |
| 615 | if (err) |
| 616 | return err; |
| 617 | } |
Marek Vasut | cd4f2d4 | 2012-07-09 18:22:53 +0200 | [diff] [blame] | 618 | |
Marek Vasut | 62885f5 | 2012-08-24 05:44:31 +0200 | [diff] [blame] | 619 | /* Setup the DMA */ |
Shawn Guo | e5aba13 | 2013-02-26 11:20:22 +0800 | [diff] [blame^] | 620 | i2c->dmach = dma_request_slave_channel(dev, "rx-tx"); |
Wolfram Sang | 82fa63b | 2012-10-12 11:55:16 +0100 | [diff] [blame] | 621 | if (!i2c->dmach) { |
| 622 | dev_err(dev, "Failed to request dma\n"); |
| 623 | return -ENODEV; |
Marek Vasut | 62885f5 | 2012-08-24 05:44:31 +0200 | [diff] [blame] | 624 | } |
| 625 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 626 | platform_set_drvdata(pdev, i2c); |
| 627 | |
| 628 | /* Do reset to enforce correct startup after pinmuxing */ |
| 629 | mxs_i2c_reset(i2c); |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 630 | |
| 631 | adap = &i2c->adapter; |
| 632 | strlcpy(adap->name, "MXS I2C adapter", sizeof(adap->name)); |
| 633 | adap->owner = THIS_MODULE; |
| 634 | adap->algo = &mxs_i2c_algo; |
| 635 | adap->dev.parent = dev; |
| 636 | adap->nr = pdev->id; |
Shawn Guo | b237866 | 2012-05-12 13:43:32 +0800 | [diff] [blame] | 637 | adap->dev.of_node = pdev->dev.of_node; |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 638 | i2c_set_adapdata(adap, i2c); |
| 639 | err = i2c_add_numbered_adapter(adap); |
| 640 | if (err) { |
| 641 | dev_err(dev, "Failed to add adapter (%d)\n", err); |
| 642 | writel(MXS_I2C_CTRL0_SFTRST, |
| 643 | i2c->regs + MXS_I2C_CTRL0_SET); |
| 644 | return err; |
| 645 | } |
| 646 | |
Shawn Guo | b237866 | 2012-05-12 13:43:32 +0800 | [diff] [blame] | 647 | of_i2c_register_devices(adap); |
| 648 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 649 | return 0; |
| 650 | } |
| 651 | |
Bill Pemberton | 0b255e9 | 2012-11-27 15:59:38 -0500 | [diff] [blame] | 652 | static int mxs_i2c_remove(struct platform_device *pdev) |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 653 | { |
| 654 | struct mxs_i2c_dev *i2c = platform_get_drvdata(pdev); |
| 655 | int ret; |
| 656 | |
| 657 | ret = i2c_del_adapter(&i2c->adapter); |
| 658 | if (ret) |
| 659 | return -EBUSY; |
| 660 | |
Marek Vasut | 62885f5 | 2012-08-24 05:44:31 +0200 | [diff] [blame] | 661 | if (i2c->dmach) |
| 662 | dma_release_channel(i2c->dmach); |
| 663 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 664 | writel(MXS_I2C_CTRL0_SFTRST, i2c->regs + MXS_I2C_CTRL0_SET); |
| 665 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 666 | return 0; |
| 667 | } |
| 668 | |
Shawn Guo | b237866 | 2012-05-12 13:43:32 +0800 | [diff] [blame] | 669 | static const struct of_device_id mxs_i2c_dt_ids[] = { |
| 670 | { .compatible = "fsl,imx28-i2c", }, |
| 671 | { /* sentinel */ } |
| 672 | }; |
| 673 | MODULE_DEVICE_TABLE(of, mxs_i2c_dt_ids); |
| 674 | |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 675 | static struct platform_driver mxs_i2c_driver = { |
| 676 | .driver = { |
| 677 | .name = DRIVER_NAME, |
| 678 | .owner = THIS_MODULE, |
Shawn Guo | b237866 | 2012-05-12 13:43:32 +0800 | [diff] [blame] | 679 | .of_match_table = mxs_i2c_dt_ids, |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 680 | }, |
Bill Pemberton | 0b255e9 | 2012-11-27 15:59:38 -0500 | [diff] [blame] | 681 | .remove = mxs_i2c_remove, |
Wolfram Sang | a8da7fe | 2011-02-16 13:39:16 +0100 | [diff] [blame] | 682 | }; |
| 683 | |
| 684 | static int __init mxs_i2c_init(void) |
| 685 | { |
| 686 | return platform_driver_probe(&mxs_i2c_driver, mxs_i2c_probe); |
| 687 | } |
| 688 | subsys_initcall(mxs_i2c_init); |
| 689 | |
| 690 | static void __exit mxs_i2c_exit(void) |
| 691 | { |
| 692 | platform_driver_unregister(&mxs_i2c_driver); |
| 693 | } |
| 694 | module_exit(mxs_i2c_exit); |
| 695 | |
| 696 | MODULE_AUTHOR("Wolfram Sang <w.sang@pengutronix.de>"); |
| 697 | MODULE_DESCRIPTION("MXS I2C Bus Driver"); |
| 698 | MODULE_LICENSE("GPL"); |
| 699 | MODULE_ALIAS("platform:" DRIVER_NAME); |