i2c-mxs.c 18 KB

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