i2c-omap.c 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937
  1. /*
  2. * TI OMAP I2C master mode driver
  3. *
  4. * Copyright (C) 2003 MontaVista Software, Inc.
  5. * Copyright (C) 2005 Nokia Corporation
  6. * Copyright (C) 2004 - 2007 Texas Instruments.
  7. *
  8. * Originally written by MontaVista Software, Inc.
  9. * Additional contributions by:
  10. * Tony Lindgren <tony@atomide.com>
  11. * Imre Deak <imre.deak@nokia.com>
  12. * Juha Yrjölä <juha.yrjola@solidboot.com>
  13. * Syed Khasim <x0khasim@ti.com>
  14. * Nishant Menon <nm@ti.com>
  15. *
  16. * This program is free software; you can redistribute it and/or modify
  17. * it under the terms of the GNU General Public License as published by
  18. * the Free Software Foundation; either version 2 of the License, or
  19. * (at your option) any later version.
  20. *
  21. * This program is distributed in the hope that it will be useful,
  22. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  24. * GNU General Public License for more details.
  25. *
  26. * You should have received a copy of the GNU General Public License
  27. * along with this program; if not, write to the Free Software
  28. * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  29. */
  30. #include <linux/module.h>
  31. #include <linux/delay.h>
  32. #include <linux/i2c.h>
  33. #include <linux/err.h>
  34. #include <linux/interrupt.h>
  35. #include <linux/completion.h>
  36. #include <linux/platform_device.h>
  37. #include <linux/clk.h>
  38. #include <linux/io.h>
  39. /* I2C controller revisions */
  40. #define OMAP_I2C_REV_2 0x20
  41. /* I2C controller revisions present on specific hardware */
  42. #define OMAP_I2C_REV_ON_2430 0x36
  43. #define OMAP_I2C_REV_ON_3430 0x3C
  44. /* timeout waiting for the controller to respond */
  45. #define OMAP_I2C_TIMEOUT (msecs_to_jiffies(1000))
  46. #define OMAP_I2C_REV_REG 0x00
  47. #define OMAP_I2C_IE_REG 0x04
  48. #define OMAP_I2C_STAT_REG 0x08
  49. #define OMAP_I2C_IV_REG 0x0c
  50. /* For OMAP3 I2C_IV has changed to I2C_WE (wakeup enable) */
  51. #define OMAP_I2C_WE_REG 0x0c
  52. #define OMAP_I2C_SYSS_REG 0x10
  53. #define OMAP_I2C_BUF_REG 0x14
  54. #define OMAP_I2C_CNT_REG 0x18
  55. #define OMAP_I2C_DATA_REG 0x1c
  56. #define OMAP_I2C_SYSC_REG 0x20
  57. #define OMAP_I2C_CON_REG 0x24
  58. #define OMAP_I2C_OA_REG 0x28
  59. #define OMAP_I2C_SA_REG 0x2c
  60. #define OMAP_I2C_PSC_REG 0x30
  61. #define OMAP_I2C_SCLL_REG 0x34
  62. #define OMAP_I2C_SCLH_REG 0x38
  63. #define OMAP_I2C_SYSTEST_REG 0x3c
  64. #define OMAP_I2C_BUFSTAT_REG 0x40
  65. /* I2C Interrupt Enable Register (OMAP_I2C_IE): */
  66. #define OMAP_I2C_IE_XDR (1 << 14) /* TX Buffer drain int enable */
  67. #define OMAP_I2C_IE_RDR (1 << 13) /* RX Buffer drain int enable */
  68. #define OMAP_I2C_IE_XRDY (1 << 4) /* TX data ready int enable */
  69. #define OMAP_I2C_IE_RRDY (1 << 3) /* RX data ready int enable */
  70. #define OMAP_I2C_IE_ARDY (1 << 2) /* Access ready int enable */
  71. #define OMAP_I2C_IE_NACK (1 << 1) /* No ack interrupt enable */
  72. #define OMAP_I2C_IE_AL (1 << 0) /* Arbitration lost int ena */
  73. /* I2C Status Register (OMAP_I2C_STAT): */
  74. #define OMAP_I2C_STAT_XDR (1 << 14) /* TX Buffer draining */
  75. #define OMAP_I2C_STAT_RDR (1 << 13) /* RX Buffer draining */
  76. #define OMAP_I2C_STAT_BB (1 << 12) /* Bus busy */
  77. #define OMAP_I2C_STAT_ROVR (1 << 11) /* Receive overrun */
  78. #define OMAP_I2C_STAT_XUDF (1 << 10) /* Transmit underflow */
  79. #define OMAP_I2C_STAT_AAS (1 << 9) /* Address as slave */
  80. #define OMAP_I2C_STAT_AD0 (1 << 8) /* Address zero */
  81. #define OMAP_I2C_STAT_XRDY (1 << 4) /* Transmit data ready */
  82. #define OMAP_I2C_STAT_RRDY (1 << 3) /* Receive data ready */
  83. #define OMAP_I2C_STAT_ARDY (1 << 2) /* Register access ready */
  84. #define OMAP_I2C_STAT_NACK (1 << 1) /* No ack interrupt enable */
  85. #define OMAP_I2C_STAT_AL (1 << 0) /* Arbitration lost int ena */
  86. /* I2C WE wakeup enable register */
  87. #define OMAP_I2C_WE_XDR_WE (1 << 14) /* TX drain wakup */
  88. #define OMAP_I2C_WE_RDR_WE (1 << 13) /* RX drain wakeup */
  89. #define OMAP_I2C_WE_AAS_WE (1 << 9) /* Address as slave wakeup*/
  90. #define OMAP_I2C_WE_BF_WE (1 << 8) /* Bus free wakeup */
  91. #define OMAP_I2C_WE_STC_WE (1 << 6) /* Start condition wakeup */
  92. #define OMAP_I2C_WE_GC_WE (1 << 5) /* General call wakeup */
  93. #define OMAP_I2C_WE_DRDY_WE (1 << 3) /* TX/RX data ready wakeup */
  94. #define OMAP_I2C_WE_ARDY_WE (1 << 2) /* Reg access ready wakeup */
  95. #define OMAP_I2C_WE_NACK_WE (1 << 1) /* No acknowledgment wakeup */
  96. #define OMAP_I2C_WE_AL_WE (1 << 0) /* Arbitration lost wakeup */
  97. #define OMAP_I2C_WE_ALL (OMAP_I2C_WE_XDR_WE | OMAP_I2C_WE_RDR_WE | \
  98. OMAP_I2C_WE_AAS_WE | OMAP_I2C_WE_BF_WE | \
  99. OMAP_I2C_WE_STC_WE | OMAP_I2C_WE_GC_WE | \
  100. OMAP_I2C_WE_DRDY_WE | OMAP_I2C_WE_ARDY_WE | \
  101. OMAP_I2C_WE_NACK_WE | OMAP_I2C_WE_AL_WE)
  102. /* I2C Buffer Configuration Register (OMAP_I2C_BUF): */
  103. #define OMAP_I2C_BUF_RDMA_EN (1 << 15) /* RX DMA channel enable */
  104. #define OMAP_I2C_BUF_RXFIF_CLR (1 << 14) /* RX FIFO Clear */
  105. #define OMAP_I2C_BUF_XDMA_EN (1 << 7) /* TX DMA channel enable */
  106. #define OMAP_I2C_BUF_TXFIF_CLR (1 << 6) /* TX FIFO Clear */
  107. /* I2C Configuration Register (OMAP_I2C_CON): */
  108. #define OMAP_I2C_CON_EN (1 << 15) /* I2C module enable */
  109. #define OMAP_I2C_CON_BE (1 << 14) /* Big endian mode */
  110. #define OMAP_I2C_CON_OPMODE_HS (1 << 12) /* High Speed support */
  111. #define OMAP_I2C_CON_STB (1 << 11) /* Start byte mode (master) */
  112. #define OMAP_I2C_CON_MST (1 << 10) /* Master/slave mode */
  113. #define OMAP_I2C_CON_TRX (1 << 9) /* TX/RX mode (master only) */
  114. #define OMAP_I2C_CON_XA (1 << 8) /* Expand address */
  115. #define OMAP_I2C_CON_RM (1 << 2) /* Repeat mode (master only) */
  116. #define OMAP_I2C_CON_STP (1 << 1) /* Stop cond (master only) */
  117. #define OMAP_I2C_CON_STT (1 << 0) /* Start condition (master) */
  118. /* I2C SCL time value when Master */
  119. #define OMAP_I2C_SCLL_HSSCLL 8
  120. #define OMAP_I2C_SCLH_HSSCLH 8
  121. /* I2C System Test Register (OMAP_I2C_SYSTEST): */
  122. #ifdef DEBUG
  123. #define OMAP_I2C_SYSTEST_ST_EN (1 << 15) /* System test enable */
  124. #define OMAP_I2C_SYSTEST_FREE (1 << 14) /* Free running mode */
  125. #define OMAP_I2C_SYSTEST_TMODE_MASK (3 << 12) /* Test mode select */
  126. #define OMAP_I2C_SYSTEST_TMODE_SHIFT (12) /* Test mode select */
  127. #define OMAP_I2C_SYSTEST_SCL_I (1 << 3) /* SCL line sense in */
  128. #define OMAP_I2C_SYSTEST_SCL_O (1 << 2) /* SCL line drive out */
  129. #define OMAP_I2C_SYSTEST_SDA_I (1 << 1) /* SDA line sense in */
  130. #define OMAP_I2C_SYSTEST_SDA_O (1 << 0) /* SDA line drive out */
  131. #endif
  132. /* OCP_SYSSTATUS bit definitions */
  133. #define SYSS_RESETDONE_MASK (1 << 0)
  134. /* OCP_SYSCONFIG bit definitions */
  135. #define SYSC_CLOCKACTIVITY_MASK (0x3 << 8)
  136. #define SYSC_SIDLEMODE_MASK (0x3 << 3)
  137. #define SYSC_ENAWAKEUP_MASK (1 << 2)
  138. #define SYSC_SOFTRESET_MASK (1 << 1)
  139. #define SYSC_AUTOIDLE_MASK (1 << 0)
  140. #define SYSC_IDLEMODE_SMART 0x2
  141. #define SYSC_CLOCKACTIVITY_FCLK 0x2
  142. struct omap_i2c_dev {
  143. struct device *dev;
  144. void __iomem *base; /* virtual */
  145. int irq;
  146. struct clk *iclk; /* Interface clock */
  147. struct clk *fclk; /* Functional clock */
  148. struct completion cmd_complete;
  149. struct resource *ioarea;
  150. u32 speed; /* Speed of bus in Khz */
  151. u16 cmd_err;
  152. u8 *buf;
  153. size_t buf_len;
  154. struct i2c_adapter adapter;
  155. u8 fifo_size; /* use as flag and value
  156. * fifo_size==0 implies no fifo
  157. * if set, should be trsh+1
  158. */
  159. u8 rev;
  160. unsigned b_hw:1; /* bad h/w fixes */
  161. unsigned idle:1;
  162. u16 iestate; /* Saved interrupt register */
  163. };
  164. static inline void omap_i2c_write_reg(struct omap_i2c_dev *i2c_dev,
  165. int reg, u16 val)
  166. {
  167. __raw_writew(val, i2c_dev->base + reg);
  168. }
  169. static inline u16 omap_i2c_read_reg(struct omap_i2c_dev *i2c_dev, int reg)
  170. {
  171. return __raw_readw(i2c_dev->base + reg);
  172. }
  173. static int __init omap_i2c_get_clocks(struct omap_i2c_dev *dev)
  174. {
  175. int ret;
  176. dev->iclk = clk_get(dev->dev, "ick");
  177. if (IS_ERR(dev->iclk)) {
  178. ret = PTR_ERR(dev->iclk);
  179. dev->iclk = NULL;
  180. return ret;
  181. }
  182. dev->fclk = clk_get(dev->dev, "fck");
  183. if (IS_ERR(dev->fclk)) {
  184. ret = PTR_ERR(dev->fclk);
  185. if (dev->iclk != NULL) {
  186. clk_put(dev->iclk);
  187. dev->iclk = NULL;
  188. }
  189. dev->fclk = NULL;
  190. return ret;
  191. }
  192. return 0;
  193. }
  194. static void omap_i2c_put_clocks(struct omap_i2c_dev *dev)
  195. {
  196. clk_put(dev->fclk);
  197. dev->fclk = NULL;
  198. clk_put(dev->iclk);
  199. dev->iclk = NULL;
  200. }
  201. static void omap_i2c_unidle(struct omap_i2c_dev *dev)
  202. {
  203. WARN_ON(!dev->idle);
  204. clk_enable(dev->iclk);
  205. clk_enable(dev->fclk);
  206. dev->idle = 0;
  207. if (dev->iestate)
  208. omap_i2c_write_reg(dev, OMAP_I2C_IE_REG, dev->iestate);
  209. }
  210. static void omap_i2c_idle(struct omap_i2c_dev *dev)
  211. {
  212. u16 iv;
  213. WARN_ON(dev->idle);
  214. dev->iestate = omap_i2c_read_reg(dev, OMAP_I2C_IE_REG);
  215. omap_i2c_write_reg(dev, OMAP_I2C_IE_REG, 0);
  216. if (dev->rev < OMAP_I2C_REV_2) {
  217. iv = omap_i2c_read_reg(dev, OMAP_I2C_IV_REG); /* Read clears */
  218. } else {
  219. omap_i2c_write_reg(dev, OMAP_I2C_STAT_REG, dev->iestate);
  220. /* Flush posted write before the dev->idle store occurs */
  221. omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG);
  222. }
  223. dev->idle = 1;
  224. clk_disable(dev->fclk);
  225. clk_disable(dev->iclk);
  226. }
  227. static int omap_i2c_init(struct omap_i2c_dev *dev)
  228. {
  229. u16 psc = 0, scll = 0, sclh = 0;
  230. u16 fsscll = 0, fssclh = 0, hsscll = 0, hssclh = 0;
  231. unsigned long fclk_rate = 12000000;
  232. unsigned long timeout;
  233. unsigned long internal_clk = 0;
  234. if (dev->rev >= OMAP_I2C_REV_2) {
  235. omap_i2c_write_reg(dev, OMAP_I2C_SYSC_REG, SYSC_SOFTRESET_MASK);
  236. /* For some reason we need to set the EN bit before the
  237. * reset done bit gets set. */
  238. timeout = jiffies + OMAP_I2C_TIMEOUT;
  239. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_EN);
  240. while (!(omap_i2c_read_reg(dev, OMAP_I2C_SYSS_REG) &
  241. SYSS_RESETDONE_MASK)) {
  242. if (time_after(jiffies, timeout)) {
  243. dev_warn(dev->dev, "timeout waiting "
  244. "for controller reset\n");
  245. return -ETIMEDOUT;
  246. }
  247. msleep(1);
  248. }
  249. /* SYSC register is cleared by the reset; rewrite it */
  250. if (dev->rev == OMAP_I2C_REV_ON_2430) {
  251. omap_i2c_write_reg(dev, OMAP_I2C_SYSC_REG,
  252. SYSC_AUTOIDLE_MASK);
  253. } else if (dev->rev >= OMAP_I2C_REV_ON_3430) {
  254. u32 v;
  255. v = SYSC_AUTOIDLE_MASK;
  256. v |= SYSC_ENAWAKEUP_MASK;
  257. v |= (SYSC_IDLEMODE_SMART <<
  258. __ffs(SYSC_SIDLEMODE_MASK));
  259. v |= (SYSC_CLOCKACTIVITY_FCLK <<
  260. __ffs(SYSC_CLOCKACTIVITY_MASK));
  261. omap_i2c_write_reg(dev, OMAP_I2C_SYSC_REG, v);
  262. /*
  263. * Enabling all wakup sources to stop I2C freezing on
  264. * WFI instruction.
  265. * REVISIT: Some wkup sources might not be needed.
  266. */
  267. omap_i2c_write_reg(dev, OMAP_I2C_WE_REG,
  268. OMAP_I2C_WE_ALL);
  269. }
  270. }
  271. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
  272. if (cpu_class_is_omap1()) {
  273. /*
  274. * The I2C functional clock is the armxor_ck, so there's
  275. * no need to get "armxor_ck" separately. Now, if OMAP2420
  276. * always returns 12MHz for the functional clock, we can
  277. * do this bit unconditionally.
  278. */
  279. fclk_rate = clk_get_rate(dev->fclk);
  280. /* TRM for 5912 says the I2C clock must be prescaled to be
  281. * between 7 - 12 MHz. The XOR input clock is typically
  282. * 12, 13 or 19.2 MHz. So we should have code that produces:
  283. *
  284. * XOR MHz Divider Prescaler
  285. * 12 1 0
  286. * 13 2 1
  287. * 19.2 2 1
  288. */
  289. if (fclk_rate > 12000000)
  290. psc = fclk_rate / 12000000;
  291. }
  292. if (cpu_is_omap2430() || cpu_is_omap34xx()) {
  293. /* HSI2C controller internal clk rate should be 19.2 Mhz */
  294. internal_clk = 19200;
  295. fclk_rate = clk_get_rate(dev->fclk) / 1000;
  296. /* Compute prescaler divisor */
  297. psc = fclk_rate / internal_clk;
  298. psc = psc - 1;
  299. /* If configured for High Speed */
  300. if (dev->speed > 400) {
  301. /* For first phase of HS mode */
  302. fsscll = internal_clk / (400 * 2) - 6;
  303. fssclh = internal_clk / (400 * 2) - 6;
  304. /* For second phase of HS mode */
  305. hsscll = fclk_rate / (dev->speed * 2) - 6;
  306. hssclh = fclk_rate / (dev->speed * 2) - 6;
  307. } else {
  308. /* To handle F/S modes */
  309. fsscll = internal_clk / (dev->speed * 2) - 6;
  310. fssclh = internal_clk / (dev->speed * 2) - 6;
  311. }
  312. scll = (hsscll << OMAP_I2C_SCLL_HSSCLL) | fsscll;
  313. sclh = (hssclh << OMAP_I2C_SCLH_HSSCLH) | fssclh;
  314. } else {
  315. /* Program desired operating rate */
  316. fclk_rate /= (psc + 1) * 1000;
  317. if (psc > 2)
  318. psc = 2;
  319. scll = fclk_rate / (dev->speed * 2) - 7 + psc;
  320. sclh = fclk_rate / (dev->speed * 2) - 7 + psc;
  321. }
  322. /* Setup clock prescaler to obtain approx 12MHz I2C module clock: */
  323. omap_i2c_write_reg(dev, OMAP_I2C_PSC_REG, psc);
  324. /* SCL low and high time values */
  325. omap_i2c_write_reg(dev, OMAP_I2C_SCLL_REG, scll);
  326. omap_i2c_write_reg(dev, OMAP_I2C_SCLH_REG, sclh);
  327. if (dev->fifo_size)
  328. /* Note: setup required fifo size - 1 */
  329. omap_i2c_write_reg(dev, OMAP_I2C_BUF_REG,
  330. (dev->fifo_size - 1) << 8 | /* RTRSH */
  331. OMAP_I2C_BUF_RXFIF_CLR |
  332. (dev->fifo_size - 1) | /* XTRSH */
  333. OMAP_I2C_BUF_TXFIF_CLR);
  334. /* Take the I2C module out of reset: */
  335. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_EN);
  336. /* Enable interrupts */
  337. omap_i2c_write_reg(dev, OMAP_I2C_IE_REG,
  338. (OMAP_I2C_IE_XRDY | OMAP_I2C_IE_RRDY |
  339. OMAP_I2C_IE_ARDY | OMAP_I2C_IE_NACK |
  340. OMAP_I2C_IE_AL) | ((dev->fifo_size) ?
  341. (OMAP_I2C_IE_RDR | OMAP_I2C_IE_XDR) : 0));
  342. return 0;
  343. }
  344. /*
  345. * Waiting on Bus Busy
  346. */
  347. static int omap_i2c_wait_for_bb(struct omap_i2c_dev *dev)
  348. {
  349. unsigned long timeout;
  350. timeout = jiffies + OMAP_I2C_TIMEOUT;
  351. while (omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG) & OMAP_I2C_STAT_BB) {
  352. if (time_after(jiffies, timeout)) {
  353. dev_warn(dev->dev, "timeout waiting for bus ready\n");
  354. return -ETIMEDOUT;
  355. }
  356. msleep(1);
  357. }
  358. return 0;
  359. }
  360. /*
  361. * Low level master read/write transaction.
  362. */
  363. static int omap_i2c_xfer_msg(struct i2c_adapter *adap,
  364. struct i2c_msg *msg, int stop)
  365. {
  366. struct omap_i2c_dev *dev = i2c_get_adapdata(adap);
  367. int r;
  368. u16 w;
  369. dev_dbg(dev->dev, "addr: 0x%04x, len: %d, flags: 0x%x, stop: %d\n",
  370. msg->addr, msg->len, msg->flags, stop);
  371. if (msg->len == 0)
  372. return -EINVAL;
  373. omap_i2c_write_reg(dev, OMAP_I2C_SA_REG, msg->addr);
  374. /* REVISIT: Could the STB bit of I2C_CON be used with probing? */
  375. dev->buf = msg->buf;
  376. dev->buf_len = msg->len;
  377. omap_i2c_write_reg(dev, OMAP_I2C_CNT_REG, dev->buf_len);
  378. /* Clear the FIFO Buffers */
  379. w = omap_i2c_read_reg(dev, OMAP_I2C_BUF_REG);
  380. w |= OMAP_I2C_BUF_RXFIF_CLR | OMAP_I2C_BUF_TXFIF_CLR;
  381. omap_i2c_write_reg(dev, OMAP_I2C_BUF_REG, w);
  382. init_completion(&dev->cmd_complete);
  383. dev->cmd_err = 0;
  384. w = OMAP_I2C_CON_EN | OMAP_I2C_CON_MST | OMAP_I2C_CON_STT;
  385. /* High speed configuration */
  386. if (dev->speed > 400)
  387. w |= OMAP_I2C_CON_OPMODE_HS;
  388. if (msg->flags & I2C_M_TEN)
  389. w |= OMAP_I2C_CON_XA;
  390. if (!(msg->flags & I2C_M_RD))
  391. w |= OMAP_I2C_CON_TRX;
  392. if (!dev->b_hw && stop)
  393. w |= OMAP_I2C_CON_STP;
  394. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
  395. /*
  396. * Don't write stt and stp together on some hardware.
  397. */
  398. if (dev->b_hw && stop) {
  399. unsigned long delay = jiffies + OMAP_I2C_TIMEOUT;
  400. u16 con = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
  401. while (con & OMAP_I2C_CON_STT) {
  402. con = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
  403. /* Let the user know if i2c is in a bad state */
  404. if (time_after(jiffies, delay)) {
  405. dev_err(dev->dev, "controller timed out "
  406. "waiting for start condition to finish\n");
  407. return -ETIMEDOUT;
  408. }
  409. cpu_relax();
  410. }
  411. w |= OMAP_I2C_CON_STP;
  412. w &= ~OMAP_I2C_CON_STT;
  413. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
  414. }
  415. /*
  416. * REVISIT: We should abort the transfer on signals, but the bus goes
  417. * into arbitration and we're currently unable to recover from it.
  418. */
  419. r = wait_for_completion_timeout(&dev->cmd_complete,
  420. OMAP_I2C_TIMEOUT);
  421. dev->buf_len = 0;
  422. if (r < 0)
  423. return r;
  424. if (r == 0) {
  425. dev_err(dev->dev, "controller timed out\n");
  426. omap_i2c_init(dev);
  427. return -ETIMEDOUT;
  428. }
  429. if (likely(!dev->cmd_err))
  430. return 0;
  431. /* We have an error */
  432. if (dev->cmd_err & (OMAP_I2C_STAT_AL | OMAP_I2C_STAT_ROVR |
  433. OMAP_I2C_STAT_XUDF)) {
  434. omap_i2c_init(dev);
  435. return -EIO;
  436. }
  437. if (dev->cmd_err & OMAP_I2C_STAT_NACK) {
  438. if (msg->flags & I2C_M_IGNORE_NAK)
  439. return 0;
  440. if (stop) {
  441. w = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
  442. w |= OMAP_I2C_CON_STP;
  443. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
  444. }
  445. return -EREMOTEIO;
  446. }
  447. return -EIO;
  448. }
  449. /*
  450. * Prepare controller for a transaction and call omap_i2c_xfer_msg
  451. * to do the work during IRQ processing.
  452. */
  453. static int
  454. omap_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
  455. {
  456. struct omap_i2c_dev *dev = i2c_get_adapdata(adap);
  457. int i;
  458. int r;
  459. omap_i2c_unidle(dev);
  460. r = omap_i2c_wait_for_bb(dev);
  461. if (r < 0)
  462. goto out;
  463. for (i = 0; i < num; i++) {
  464. r = omap_i2c_xfer_msg(adap, &msgs[i], (i == (num - 1)));
  465. if (r != 0)
  466. break;
  467. }
  468. if (r == 0)
  469. r = num;
  470. out:
  471. omap_i2c_idle(dev);
  472. return r;
  473. }
  474. static u32
  475. omap_i2c_func(struct i2c_adapter *adap)
  476. {
  477. return I2C_FUNC_I2C | (I2C_FUNC_SMBUS_EMUL & ~I2C_FUNC_SMBUS_QUICK);
  478. }
  479. static inline void
  480. omap_i2c_complete_cmd(struct omap_i2c_dev *dev, u16 err)
  481. {
  482. dev->cmd_err |= err;
  483. complete(&dev->cmd_complete);
  484. }
  485. static inline void
  486. omap_i2c_ack_stat(struct omap_i2c_dev *dev, u16 stat)
  487. {
  488. omap_i2c_write_reg(dev, OMAP_I2C_STAT_REG, stat);
  489. }
  490. /* rev1 devices are apparently only on some 15xx */
  491. #ifdef CONFIG_ARCH_OMAP15XX
  492. static irqreturn_t
  493. omap_i2c_rev1_isr(int this_irq, void *dev_id)
  494. {
  495. struct omap_i2c_dev *dev = dev_id;
  496. u16 iv, w;
  497. if (dev->idle)
  498. return IRQ_NONE;
  499. iv = omap_i2c_read_reg(dev, OMAP_I2C_IV_REG);
  500. switch (iv) {
  501. case 0x00: /* None */
  502. break;
  503. case 0x01: /* Arbitration lost */
  504. dev_err(dev->dev, "Arbitration lost\n");
  505. omap_i2c_complete_cmd(dev, OMAP_I2C_STAT_AL);
  506. break;
  507. case 0x02: /* No acknowledgement */
  508. omap_i2c_complete_cmd(dev, OMAP_I2C_STAT_NACK);
  509. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_STP);
  510. break;
  511. case 0x03: /* Register access ready */
  512. omap_i2c_complete_cmd(dev, 0);
  513. break;
  514. case 0x04: /* Receive data ready */
  515. if (dev->buf_len) {
  516. w = omap_i2c_read_reg(dev, OMAP_I2C_DATA_REG);
  517. *dev->buf++ = w;
  518. dev->buf_len--;
  519. if (dev->buf_len) {
  520. *dev->buf++ = w >> 8;
  521. dev->buf_len--;
  522. }
  523. } else
  524. dev_err(dev->dev, "RRDY IRQ while no data requested\n");
  525. break;
  526. case 0x05: /* Transmit data ready */
  527. if (dev->buf_len) {
  528. w = *dev->buf++;
  529. dev->buf_len--;
  530. if (dev->buf_len) {
  531. w |= *dev->buf++ << 8;
  532. dev->buf_len--;
  533. }
  534. omap_i2c_write_reg(dev, OMAP_I2C_DATA_REG, w);
  535. } else
  536. dev_err(dev->dev, "XRDY IRQ while no data to send\n");
  537. break;
  538. default:
  539. return IRQ_NONE;
  540. }
  541. return IRQ_HANDLED;
  542. }
  543. #else
  544. #define omap_i2c_rev1_isr NULL
  545. #endif
  546. static irqreturn_t
  547. omap_i2c_isr(int this_irq, void *dev_id)
  548. {
  549. struct omap_i2c_dev *dev = dev_id;
  550. u16 bits;
  551. u16 stat, w;
  552. int err, count = 0;
  553. if (dev->idle)
  554. return IRQ_NONE;
  555. bits = omap_i2c_read_reg(dev, OMAP_I2C_IE_REG);
  556. while ((stat = (omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG))) & bits) {
  557. dev_dbg(dev->dev, "IRQ (ISR = 0x%04x)\n", stat);
  558. if (count++ == 100) {
  559. dev_warn(dev->dev, "Too much work in one IRQ\n");
  560. break;
  561. }
  562. omap_i2c_write_reg(dev, OMAP_I2C_STAT_REG, stat);
  563. err = 0;
  564. if (stat & OMAP_I2C_STAT_NACK) {
  565. err |= OMAP_I2C_STAT_NACK;
  566. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG,
  567. OMAP_I2C_CON_STP);
  568. }
  569. if (stat & OMAP_I2C_STAT_AL) {
  570. dev_err(dev->dev, "Arbitration lost\n");
  571. err |= OMAP_I2C_STAT_AL;
  572. }
  573. if (stat & (OMAP_I2C_STAT_ARDY | OMAP_I2C_STAT_NACK |
  574. OMAP_I2C_STAT_AL))
  575. omap_i2c_complete_cmd(dev, err);
  576. if (stat & (OMAP_I2C_STAT_RRDY | OMAP_I2C_STAT_RDR)) {
  577. u8 num_bytes = 1;
  578. if (dev->fifo_size) {
  579. if (stat & OMAP_I2C_STAT_RRDY)
  580. num_bytes = dev->fifo_size;
  581. else
  582. num_bytes = omap_i2c_read_reg(dev,
  583. OMAP_I2C_BUFSTAT_REG);
  584. }
  585. while (num_bytes) {
  586. num_bytes--;
  587. w = omap_i2c_read_reg(dev, OMAP_I2C_DATA_REG);
  588. if (dev->buf_len) {
  589. *dev->buf++ = w;
  590. dev->buf_len--;
  591. /* Data reg from 2430 is 8 bit wide */
  592. if (!cpu_is_omap2430() &&
  593. !cpu_is_omap34xx()) {
  594. if (dev->buf_len) {
  595. *dev->buf++ = w >> 8;
  596. dev->buf_len--;
  597. }
  598. }
  599. } else {
  600. if (stat & OMAP_I2C_STAT_RRDY)
  601. dev_err(dev->dev,
  602. "RRDY IRQ while no data"
  603. " requested\n");
  604. if (stat & OMAP_I2C_STAT_RDR)
  605. dev_err(dev->dev,
  606. "RDR IRQ while no data"
  607. " requested\n");
  608. break;
  609. }
  610. }
  611. omap_i2c_ack_stat(dev,
  612. stat & (OMAP_I2C_STAT_RRDY | OMAP_I2C_STAT_RDR));
  613. continue;
  614. }
  615. if (stat & (OMAP_I2C_STAT_XRDY | OMAP_I2C_STAT_XDR)) {
  616. u8 num_bytes = 1;
  617. if (dev->fifo_size) {
  618. if (stat & OMAP_I2C_STAT_XRDY)
  619. num_bytes = dev->fifo_size;
  620. else
  621. num_bytes = omap_i2c_read_reg(dev,
  622. OMAP_I2C_BUFSTAT_REG);
  623. }
  624. while (num_bytes) {
  625. num_bytes--;
  626. w = 0;
  627. if (dev->buf_len) {
  628. w = *dev->buf++;
  629. dev->buf_len--;
  630. /* Data reg from 2430 is 8 bit wide */
  631. if (!cpu_is_omap2430() &&
  632. !cpu_is_omap34xx()) {
  633. if (dev->buf_len) {
  634. w |= *dev->buf++ << 8;
  635. dev->buf_len--;
  636. }
  637. }
  638. } else {
  639. if (stat & OMAP_I2C_STAT_XRDY)
  640. dev_err(dev->dev,
  641. "XRDY IRQ while no "
  642. "data to send\n");
  643. if (stat & OMAP_I2C_STAT_XDR)
  644. dev_err(dev->dev,
  645. "XDR IRQ while no "
  646. "data to send\n");
  647. break;
  648. }
  649. omap_i2c_write_reg(dev, OMAP_I2C_DATA_REG, w);
  650. }
  651. omap_i2c_ack_stat(dev,
  652. stat & (OMAP_I2C_STAT_XRDY | OMAP_I2C_STAT_XDR));
  653. continue;
  654. }
  655. if (stat & OMAP_I2C_STAT_ROVR) {
  656. dev_err(dev->dev, "Receive overrun\n");
  657. dev->cmd_err |= OMAP_I2C_STAT_ROVR;
  658. }
  659. if (stat & OMAP_I2C_STAT_XUDF) {
  660. dev_err(dev->dev, "Transmit underflow\n");
  661. dev->cmd_err |= OMAP_I2C_STAT_XUDF;
  662. }
  663. }
  664. return count ? IRQ_HANDLED : IRQ_NONE;
  665. }
  666. static const struct i2c_algorithm omap_i2c_algo = {
  667. .master_xfer = omap_i2c_xfer,
  668. .functionality = omap_i2c_func,
  669. };
  670. static int __init
  671. omap_i2c_probe(struct platform_device *pdev)
  672. {
  673. struct omap_i2c_dev *dev;
  674. struct i2c_adapter *adap;
  675. struct resource *mem, *irq, *ioarea;
  676. irq_handler_t isr;
  677. int r;
  678. u32 speed = 0;
  679. /* NOTE: driver uses the static register mapping */
  680. mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  681. if (!mem) {
  682. dev_err(&pdev->dev, "no mem resource?\n");
  683. return -ENODEV;
  684. }
  685. irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
  686. if (!irq) {
  687. dev_err(&pdev->dev, "no irq resource?\n");
  688. return -ENODEV;
  689. }
  690. ioarea = request_mem_region(mem->start, (mem->end - mem->start) + 1,
  691. pdev->name);
  692. if (!ioarea) {
  693. dev_err(&pdev->dev, "I2C region already claimed\n");
  694. return -EBUSY;
  695. }
  696. dev = kzalloc(sizeof(struct omap_i2c_dev), GFP_KERNEL);
  697. if (!dev) {
  698. r = -ENOMEM;
  699. goto err_release_region;
  700. }
  701. if (pdev->dev.platform_data != NULL)
  702. speed = *(u32 *)pdev->dev.platform_data;
  703. else
  704. speed = 100; /* Defualt speed */
  705. dev->speed = speed;
  706. dev->idle = 1;
  707. dev->dev = &pdev->dev;
  708. dev->irq = irq->start;
  709. dev->base = ioremap(mem->start, mem->end - mem->start + 1);
  710. if (!dev->base) {
  711. r = -ENOMEM;
  712. goto err_free_mem;
  713. }
  714. platform_set_drvdata(pdev, dev);
  715. if ((r = omap_i2c_get_clocks(dev)) != 0)
  716. goto err_iounmap;
  717. omap_i2c_unidle(dev);
  718. dev->rev = omap_i2c_read_reg(dev, OMAP_I2C_REV_REG) & 0xff;
  719. if (cpu_is_omap2430() || cpu_is_omap34xx()) {
  720. u16 s;
  721. /* Set up the fifo size - Get total size */
  722. s = (omap_i2c_read_reg(dev, OMAP_I2C_BUFSTAT_REG) >> 14) & 0x3;
  723. dev->fifo_size = 0x8 << s;
  724. /*
  725. * Set up notification threshold as half the total available
  726. * size. This is to ensure that we can handle the status on int
  727. * call back latencies.
  728. */
  729. dev->fifo_size = (dev->fifo_size / 2);
  730. dev->b_hw = 1; /* Enable hardware fixes */
  731. }
  732. /* reset ASAP, clearing any IRQs */
  733. omap_i2c_init(dev);
  734. isr = (dev->rev < OMAP_I2C_REV_2) ? omap_i2c_rev1_isr : omap_i2c_isr;
  735. r = request_irq(dev->irq, isr, 0, pdev->name, dev);
  736. if (r) {
  737. dev_err(dev->dev, "failure requesting irq %i\n", dev->irq);
  738. goto err_unuse_clocks;
  739. }
  740. dev_info(dev->dev, "bus %d rev%d.%d at %d kHz\n",
  741. pdev->id, dev->rev >> 4, dev->rev & 0xf, dev->speed);
  742. omap_i2c_idle(dev);
  743. adap = &dev->adapter;
  744. i2c_set_adapdata(adap, dev);
  745. adap->owner = THIS_MODULE;
  746. adap->class = I2C_CLASS_HWMON;
  747. strncpy(adap->name, "OMAP I2C adapter", sizeof(adap->name));
  748. adap->algo = &omap_i2c_algo;
  749. adap->dev.parent = &pdev->dev;
  750. /* i2c device drivers may be active on return from add_adapter() */
  751. adap->nr = pdev->id;
  752. r = i2c_add_numbered_adapter(adap);
  753. if (r) {
  754. dev_err(dev->dev, "failure adding adapter\n");
  755. goto err_free_irq;
  756. }
  757. return 0;
  758. err_free_irq:
  759. free_irq(dev->irq, dev);
  760. err_unuse_clocks:
  761. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
  762. omap_i2c_idle(dev);
  763. omap_i2c_put_clocks(dev);
  764. err_iounmap:
  765. iounmap(dev->base);
  766. err_free_mem:
  767. platform_set_drvdata(pdev, NULL);
  768. kfree(dev);
  769. err_release_region:
  770. release_mem_region(mem->start, (mem->end - mem->start) + 1);
  771. return r;
  772. }
  773. static int
  774. omap_i2c_remove(struct platform_device *pdev)
  775. {
  776. struct omap_i2c_dev *dev = platform_get_drvdata(pdev);
  777. struct resource *mem;
  778. platform_set_drvdata(pdev, NULL);
  779. free_irq(dev->irq, dev);
  780. i2c_del_adapter(&dev->adapter);
  781. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
  782. omap_i2c_put_clocks(dev);
  783. iounmap(dev->base);
  784. kfree(dev);
  785. mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  786. release_mem_region(mem->start, (mem->end - mem->start) + 1);
  787. return 0;
  788. }
  789. static struct platform_driver omap_i2c_driver = {
  790. .probe = omap_i2c_probe,
  791. .remove = omap_i2c_remove,
  792. .driver = {
  793. .name = "i2c_omap",
  794. .owner = THIS_MODULE,
  795. },
  796. };
  797. /* I2C may be needed to bring up other drivers */
  798. static int __init
  799. omap_i2c_init_driver(void)
  800. {
  801. return platform_driver_register(&omap_i2c_driver);
  802. }
  803. subsys_initcall(omap_i2c_init_driver);
  804. static void __exit omap_i2c_exit_driver(void)
  805. {
  806. platform_driver_unregister(&omap_i2c_driver);
  807. }
  808. module_exit(omap_i2c_exit_driver);
  809. MODULE_AUTHOR("MontaVista Software, Inc. (and others)");
  810. MODULE_DESCRIPTION("TI OMAP I2C bus adapter");
  811. MODULE_LICENSE("GPL");
  812. MODULE_ALIAS("platform:i2c_omap");