i2c-omap.c 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360
  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. #include <linux/module.h>
  27. #include <linux/delay.h>
  28. #include <linux/i2c.h>
  29. #include <linux/err.h>
  30. #include <linux/interrupt.h>
  31. #include <linux/completion.h>
  32. #include <linux/platform_device.h>
  33. #include <linux/clk.h>
  34. #include <linux/io.h>
  35. #include <linux/of.h>
  36. #include <linux/of_device.h>
  37. #include <linux/slab.h>
  38. #include <linux/i2c-omap.h>
  39. #include <linux/pm_runtime.h>
  40. /* I2C controller revisions */
  41. #define OMAP_I2C_OMAP1_REV_2 0x20
  42. /* I2C controller revisions present on specific hardware */
  43. #define OMAP_I2C_REV_ON_2430 0x00000036
  44. #define OMAP_I2C_REV_ON_3430_3530 0x0000003C
  45. #define OMAP_I2C_REV_ON_3630 0x00000040
  46. #define OMAP_I2C_REV_ON_4430_PLUS 0x50400002
  47. /* timeout waiting for the controller to respond */
  48. #define OMAP_I2C_TIMEOUT (msecs_to_jiffies(1000))
  49. /* timeout for pm runtime autosuspend */
  50. #define OMAP_I2C_PM_TIMEOUT 1000 /* ms */
  51. /* For OMAP3 I2C_IV has changed to I2C_WE (wakeup enable) */
  52. enum {
  53. OMAP_I2C_REV_REG = 0,
  54. OMAP_I2C_IE_REG,
  55. OMAP_I2C_STAT_REG,
  56. OMAP_I2C_IV_REG,
  57. OMAP_I2C_WE_REG,
  58. OMAP_I2C_SYSS_REG,
  59. OMAP_I2C_BUF_REG,
  60. OMAP_I2C_CNT_REG,
  61. OMAP_I2C_DATA_REG,
  62. OMAP_I2C_SYSC_REG,
  63. OMAP_I2C_CON_REG,
  64. OMAP_I2C_OA_REG,
  65. OMAP_I2C_SA_REG,
  66. OMAP_I2C_PSC_REG,
  67. OMAP_I2C_SCLL_REG,
  68. OMAP_I2C_SCLH_REG,
  69. OMAP_I2C_SYSTEST_REG,
  70. OMAP_I2C_BUFSTAT_REG,
  71. /* only on OMAP4430 */
  72. OMAP_I2C_IP_V2_REVNB_LO,
  73. OMAP_I2C_IP_V2_REVNB_HI,
  74. OMAP_I2C_IP_V2_IRQSTATUS_RAW,
  75. OMAP_I2C_IP_V2_IRQENABLE_SET,
  76. OMAP_I2C_IP_V2_IRQENABLE_CLR,
  77. };
  78. /* I2C Interrupt Enable Register (OMAP_I2C_IE): */
  79. #define OMAP_I2C_IE_XDR (1 << 14) /* TX Buffer drain int enable */
  80. #define OMAP_I2C_IE_RDR (1 << 13) /* RX Buffer drain int enable */
  81. #define OMAP_I2C_IE_XRDY (1 << 4) /* TX data ready int enable */
  82. #define OMAP_I2C_IE_RRDY (1 << 3) /* RX data ready int enable */
  83. #define OMAP_I2C_IE_ARDY (1 << 2) /* Access ready int enable */
  84. #define OMAP_I2C_IE_NACK (1 << 1) /* No ack interrupt enable */
  85. #define OMAP_I2C_IE_AL (1 << 0) /* Arbitration lost int ena */
  86. /* I2C Status Register (OMAP_I2C_STAT): */
  87. #define OMAP_I2C_STAT_XDR (1 << 14) /* TX Buffer draining */
  88. #define OMAP_I2C_STAT_RDR (1 << 13) /* RX Buffer draining */
  89. #define OMAP_I2C_STAT_BB (1 << 12) /* Bus busy */
  90. #define OMAP_I2C_STAT_ROVR (1 << 11) /* Receive overrun */
  91. #define OMAP_I2C_STAT_XUDF (1 << 10) /* Transmit underflow */
  92. #define OMAP_I2C_STAT_AAS (1 << 9) /* Address as slave */
  93. #define OMAP_I2C_STAT_AD0 (1 << 8) /* Address zero */
  94. #define OMAP_I2C_STAT_XRDY (1 << 4) /* Transmit data ready */
  95. #define OMAP_I2C_STAT_RRDY (1 << 3) /* Receive data ready */
  96. #define OMAP_I2C_STAT_ARDY (1 << 2) /* Register access ready */
  97. #define OMAP_I2C_STAT_NACK (1 << 1) /* No ack interrupt enable */
  98. #define OMAP_I2C_STAT_AL (1 << 0) /* Arbitration lost int ena */
  99. /* I2C WE wakeup enable register */
  100. #define OMAP_I2C_WE_XDR_WE (1 << 14) /* TX drain wakup */
  101. #define OMAP_I2C_WE_RDR_WE (1 << 13) /* RX drain wakeup */
  102. #define OMAP_I2C_WE_AAS_WE (1 << 9) /* Address as slave wakeup*/
  103. #define OMAP_I2C_WE_BF_WE (1 << 8) /* Bus free wakeup */
  104. #define OMAP_I2C_WE_STC_WE (1 << 6) /* Start condition wakeup */
  105. #define OMAP_I2C_WE_GC_WE (1 << 5) /* General call wakeup */
  106. #define OMAP_I2C_WE_DRDY_WE (1 << 3) /* TX/RX data ready wakeup */
  107. #define OMAP_I2C_WE_ARDY_WE (1 << 2) /* Reg access ready wakeup */
  108. #define OMAP_I2C_WE_NACK_WE (1 << 1) /* No acknowledgment wakeup */
  109. #define OMAP_I2C_WE_AL_WE (1 << 0) /* Arbitration lost wakeup */
  110. #define OMAP_I2C_WE_ALL (OMAP_I2C_WE_XDR_WE | OMAP_I2C_WE_RDR_WE | \
  111. OMAP_I2C_WE_AAS_WE | OMAP_I2C_WE_BF_WE | \
  112. OMAP_I2C_WE_STC_WE | OMAP_I2C_WE_GC_WE | \
  113. OMAP_I2C_WE_DRDY_WE | OMAP_I2C_WE_ARDY_WE | \
  114. OMAP_I2C_WE_NACK_WE | OMAP_I2C_WE_AL_WE)
  115. /* I2C Buffer Configuration Register (OMAP_I2C_BUF): */
  116. #define OMAP_I2C_BUF_RDMA_EN (1 << 15) /* RX DMA channel enable */
  117. #define OMAP_I2C_BUF_RXFIF_CLR (1 << 14) /* RX FIFO Clear */
  118. #define OMAP_I2C_BUF_XDMA_EN (1 << 7) /* TX DMA channel enable */
  119. #define OMAP_I2C_BUF_TXFIF_CLR (1 << 6) /* TX FIFO Clear */
  120. /* I2C Configuration Register (OMAP_I2C_CON): */
  121. #define OMAP_I2C_CON_EN (1 << 15) /* I2C module enable */
  122. #define OMAP_I2C_CON_BE (1 << 14) /* Big endian mode */
  123. #define OMAP_I2C_CON_OPMODE_HS (1 << 12) /* High Speed support */
  124. #define OMAP_I2C_CON_STB (1 << 11) /* Start byte mode (master) */
  125. #define OMAP_I2C_CON_MST (1 << 10) /* Master/slave mode */
  126. #define OMAP_I2C_CON_TRX (1 << 9) /* TX/RX mode (master only) */
  127. #define OMAP_I2C_CON_XA (1 << 8) /* Expand address */
  128. #define OMAP_I2C_CON_RM (1 << 2) /* Repeat mode (master only) */
  129. #define OMAP_I2C_CON_STP (1 << 1) /* Stop cond (master only) */
  130. #define OMAP_I2C_CON_STT (1 << 0) /* Start condition (master) */
  131. /* I2C SCL time value when Master */
  132. #define OMAP_I2C_SCLL_HSSCLL 8
  133. #define OMAP_I2C_SCLH_HSSCLH 8
  134. /* I2C System Test Register (OMAP_I2C_SYSTEST): */
  135. #ifdef DEBUG
  136. #define OMAP_I2C_SYSTEST_ST_EN (1 << 15) /* System test enable */
  137. #define OMAP_I2C_SYSTEST_FREE (1 << 14) /* Free running mode */
  138. #define OMAP_I2C_SYSTEST_TMODE_MASK (3 << 12) /* Test mode select */
  139. #define OMAP_I2C_SYSTEST_TMODE_SHIFT (12) /* Test mode select */
  140. #define OMAP_I2C_SYSTEST_SCL_I (1 << 3) /* SCL line sense in */
  141. #define OMAP_I2C_SYSTEST_SCL_O (1 << 2) /* SCL line drive out */
  142. #define OMAP_I2C_SYSTEST_SDA_I (1 << 1) /* SDA line sense in */
  143. #define OMAP_I2C_SYSTEST_SDA_O (1 << 0) /* SDA line drive out */
  144. #endif
  145. /* OCP_SYSSTATUS bit definitions */
  146. #define SYSS_RESETDONE_MASK (1 << 0)
  147. /* OCP_SYSCONFIG bit definitions */
  148. #define SYSC_CLOCKACTIVITY_MASK (0x3 << 8)
  149. #define SYSC_SIDLEMODE_MASK (0x3 << 3)
  150. #define SYSC_ENAWAKEUP_MASK (1 << 2)
  151. #define SYSC_SOFTRESET_MASK (1 << 1)
  152. #define SYSC_AUTOIDLE_MASK (1 << 0)
  153. #define SYSC_IDLEMODE_SMART 0x2
  154. #define SYSC_CLOCKACTIVITY_FCLK 0x2
  155. /* Errata definitions */
  156. #define I2C_OMAP_ERRATA_I207 (1 << 0)
  157. #define I2C_OMAP_ERRATA_I462 (1 << 1)
  158. #define OMAP_I2C_IP_V2_INTERRUPTS_MASK 0x6FFF
  159. struct omap_i2c_dev {
  160. spinlock_t lock; /* IRQ synchronization */
  161. struct device *dev;
  162. void __iomem *base; /* virtual */
  163. int irq;
  164. int reg_shift; /* bit shift for I2C register addresses */
  165. struct completion cmd_complete;
  166. struct resource *ioarea;
  167. u32 latency; /* maximum mpu wkup latency */
  168. void (*set_mpu_wkup_lat)(struct device *dev,
  169. long latency);
  170. u32 speed; /* Speed of bus in kHz */
  171. u32 flags;
  172. u16 scheme;
  173. u16 cmd_err;
  174. u8 *buf;
  175. u8 *regs;
  176. size_t buf_len;
  177. struct i2c_adapter adapter;
  178. u8 threshold;
  179. u8 fifo_size; /* use as flag and value
  180. * fifo_size==0 implies no fifo
  181. * if set, should be trsh+1
  182. */
  183. u32 rev;
  184. unsigned b_hw:1; /* bad h/w fixes */
  185. unsigned receiver:1; /* true when we're in receiver mode */
  186. u16 iestate; /* Saved interrupt register */
  187. u16 pscstate;
  188. u16 scllstate;
  189. u16 sclhstate;
  190. u16 syscstate;
  191. u16 westate;
  192. u16 errata;
  193. };
  194. static const u8 reg_map_ip_v1[] = {
  195. [OMAP_I2C_REV_REG] = 0x00,
  196. [OMAP_I2C_IE_REG] = 0x01,
  197. [OMAP_I2C_STAT_REG] = 0x02,
  198. [OMAP_I2C_IV_REG] = 0x03,
  199. [OMAP_I2C_WE_REG] = 0x03,
  200. [OMAP_I2C_SYSS_REG] = 0x04,
  201. [OMAP_I2C_BUF_REG] = 0x05,
  202. [OMAP_I2C_CNT_REG] = 0x06,
  203. [OMAP_I2C_DATA_REG] = 0x07,
  204. [OMAP_I2C_SYSC_REG] = 0x08,
  205. [OMAP_I2C_CON_REG] = 0x09,
  206. [OMAP_I2C_OA_REG] = 0x0a,
  207. [OMAP_I2C_SA_REG] = 0x0b,
  208. [OMAP_I2C_PSC_REG] = 0x0c,
  209. [OMAP_I2C_SCLL_REG] = 0x0d,
  210. [OMAP_I2C_SCLH_REG] = 0x0e,
  211. [OMAP_I2C_SYSTEST_REG] = 0x0f,
  212. [OMAP_I2C_BUFSTAT_REG] = 0x10,
  213. };
  214. static const u8 reg_map_ip_v2[] = {
  215. [OMAP_I2C_REV_REG] = 0x04,
  216. [OMAP_I2C_IE_REG] = 0x2c,
  217. [OMAP_I2C_STAT_REG] = 0x28,
  218. [OMAP_I2C_IV_REG] = 0x34,
  219. [OMAP_I2C_WE_REG] = 0x34,
  220. [OMAP_I2C_SYSS_REG] = 0x90,
  221. [OMAP_I2C_BUF_REG] = 0x94,
  222. [OMAP_I2C_CNT_REG] = 0x98,
  223. [OMAP_I2C_DATA_REG] = 0x9c,
  224. [OMAP_I2C_SYSC_REG] = 0x10,
  225. [OMAP_I2C_CON_REG] = 0xa4,
  226. [OMAP_I2C_OA_REG] = 0xa8,
  227. [OMAP_I2C_SA_REG] = 0xac,
  228. [OMAP_I2C_PSC_REG] = 0xb0,
  229. [OMAP_I2C_SCLL_REG] = 0xb4,
  230. [OMAP_I2C_SCLH_REG] = 0xb8,
  231. [OMAP_I2C_SYSTEST_REG] = 0xbC,
  232. [OMAP_I2C_BUFSTAT_REG] = 0xc0,
  233. [OMAP_I2C_IP_V2_REVNB_LO] = 0x00,
  234. [OMAP_I2C_IP_V2_REVNB_HI] = 0x04,
  235. [OMAP_I2C_IP_V2_IRQSTATUS_RAW] = 0x24,
  236. [OMAP_I2C_IP_V2_IRQENABLE_SET] = 0x2c,
  237. [OMAP_I2C_IP_V2_IRQENABLE_CLR] = 0x30,
  238. };
  239. static inline void omap_i2c_write_reg(struct omap_i2c_dev *i2c_dev,
  240. int reg, u16 val)
  241. {
  242. writew_relaxed(val, i2c_dev->base +
  243. (i2c_dev->regs[reg] << i2c_dev->reg_shift));
  244. }
  245. static inline u16 omap_i2c_read_reg(struct omap_i2c_dev *i2c_dev, int reg)
  246. {
  247. return readw_relaxed(i2c_dev->base +
  248. (i2c_dev->regs[reg] << i2c_dev->reg_shift));
  249. }
  250. static void __omap_i2c_init(struct omap_i2c_dev *dev)
  251. {
  252. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
  253. /* Setup clock prescaler to obtain approx 12MHz I2C module clock: */
  254. omap_i2c_write_reg(dev, OMAP_I2C_PSC_REG, dev->pscstate);
  255. /* SCL low and high time values */
  256. omap_i2c_write_reg(dev, OMAP_I2C_SCLL_REG, dev->scllstate);
  257. omap_i2c_write_reg(dev, OMAP_I2C_SCLH_REG, dev->sclhstate);
  258. if (dev->rev >= OMAP_I2C_REV_ON_3430_3530)
  259. omap_i2c_write_reg(dev, OMAP_I2C_WE_REG, dev->westate);
  260. /* Take the I2C module out of reset: */
  261. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_EN);
  262. /*
  263. * Don't write to this register if the IE state is 0 as it can
  264. * cause deadlock.
  265. */
  266. if (dev->iestate)
  267. omap_i2c_write_reg(dev, OMAP_I2C_IE_REG, dev->iestate);
  268. }
  269. static int omap_i2c_reset(struct omap_i2c_dev *dev)
  270. {
  271. unsigned long timeout;
  272. u16 sysc;
  273. if (dev->rev >= OMAP_I2C_OMAP1_REV_2) {
  274. sysc = omap_i2c_read_reg(dev, OMAP_I2C_SYSC_REG);
  275. /* Disable I2C controller before soft reset */
  276. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG,
  277. omap_i2c_read_reg(dev, OMAP_I2C_CON_REG) &
  278. ~(OMAP_I2C_CON_EN));
  279. omap_i2c_write_reg(dev, OMAP_I2C_SYSC_REG, SYSC_SOFTRESET_MASK);
  280. /* For some reason we need to set the EN bit before the
  281. * reset done bit gets set. */
  282. timeout = jiffies + OMAP_I2C_TIMEOUT;
  283. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_EN);
  284. while (!(omap_i2c_read_reg(dev, OMAP_I2C_SYSS_REG) &
  285. SYSS_RESETDONE_MASK)) {
  286. if (time_after(jiffies, timeout)) {
  287. dev_warn(dev->dev, "timeout waiting "
  288. "for controller reset\n");
  289. return -ETIMEDOUT;
  290. }
  291. msleep(1);
  292. }
  293. /* SYSC register is cleared by the reset; rewrite it */
  294. omap_i2c_write_reg(dev, OMAP_I2C_SYSC_REG, sysc);
  295. }
  296. return 0;
  297. }
  298. static int omap_i2c_init(struct omap_i2c_dev *dev)
  299. {
  300. u16 psc = 0, scll = 0, sclh = 0;
  301. u16 fsscll = 0, fssclh = 0, hsscll = 0, hssclh = 0;
  302. unsigned long fclk_rate = 12000000;
  303. unsigned long internal_clk = 0;
  304. struct clk *fclk;
  305. if (dev->rev >= OMAP_I2C_REV_ON_3430_3530) {
  306. /*
  307. * Enabling all wakup sources to stop I2C freezing on
  308. * WFI instruction.
  309. * REVISIT: Some wkup sources might not be needed.
  310. */
  311. dev->westate = OMAP_I2C_WE_ALL;
  312. }
  313. if (dev->flags & OMAP_I2C_FLAG_ALWAYS_ARMXOR_CLK) {
  314. /*
  315. * The I2C functional clock is the armxor_ck, so there's
  316. * no need to get "armxor_ck" separately. Now, if OMAP2420
  317. * always returns 12MHz for the functional clock, we can
  318. * do this bit unconditionally.
  319. */
  320. fclk = clk_get(dev->dev, "fck");
  321. fclk_rate = clk_get_rate(fclk);
  322. clk_put(fclk);
  323. /* TRM for 5912 says the I2C clock must be prescaled to be
  324. * between 7 - 12 MHz. The XOR input clock is typically
  325. * 12, 13 or 19.2 MHz. So we should have code that produces:
  326. *
  327. * XOR MHz Divider Prescaler
  328. * 12 1 0
  329. * 13 2 1
  330. * 19.2 2 1
  331. */
  332. if (fclk_rate > 12000000)
  333. psc = fclk_rate / 12000000;
  334. }
  335. if (!(dev->flags & OMAP_I2C_FLAG_SIMPLE_CLOCK)) {
  336. /*
  337. * HSI2C controller internal clk rate should be 19.2 Mhz for
  338. * HS and for all modes on 2430. On 34xx we can use lower rate
  339. * to get longer filter period for better noise suppression.
  340. * The filter is iclk (fclk for HS) period.
  341. */
  342. if (dev->speed > 400 ||
  343. dev->flags & OMAP_I2C_FLAG_FORCE_19200_INT_CLK)
  344. internal_clk = 19200;
  345. else if (dev->speed > 100)
  346. internal_clk = 9600;
  347. else
  348. internal_clk = 4000;
  349. fclk = clk_get(dev->dev, "fck");
  350. fclk_rate = clk_get_rate(fclk) / 1000;
  351. clk_put(fclk);
  352. /* Compute prescaler divisor */
  353. psc = fclk_rate / internal_clk;
  354. psc = psc - 1;
  355. /* If configured for High Speed */
  356. if (dev->speed > 400) {
  357. unsigned long scl;
  358. /* For first phase of HS mode */
  359. scl = internal_clk / 400;
  360. fsscll = scl - (scl / 3) - 7;
  361. fssclh = (scl / 3) - 5;
  362. /* For second phase of HS mode */
  363. scl = fclk_rate / dev->speed;
  364. hsscll = scl - (scl / 3) - 7;
  365. hssclh = (scl / 3) - 5;
  366. } else if (dev->speed > 100) {
  367. unsigned long scl;
  368. /* Fast mode */
  369. scl = internal_clk / dev->speed;
  370. fsscll = scl - (scl / 3) - 7;
  371. fssclh = (scl / 3) - 5;
  372. } else {
  373. /* Standard mode */
  374. fsscll = internal_clk / (dev->speed * 2) - 7;
  375. fssclh = internal_clk / (dev->speed * 2) - 5;
  376. }
  377. scll = (hsscll << OMAP_I2C_SCLL_HSSCLL) | fsscll;
  378. sclh = (hssclh << OMAP_I2C_SCLH_HSSCLH) | fssclh;
  379. } else {
  380. /* Program desired operating rate */
  381. fclk_rate /= (psc + 1) * 1000;
  382. if (psc > 2)
  383. psc = 2;
  384. scll = fclk_rate / (dev->speed * 2) - 7 + psc;
  385. sclh = fclk_rate / (dev->speed * 2) - 7 + psc;
  386. }
  387. dev->iestate = (OMAP_I2C_IE_XRDY | OMAP_I2C_IE_RRDY |
  388. OMAP_I2C_IE_ARDY | OMAP_I2C_IE_NACK |
  389. OMAP_I2C_IE_AL) | ((dev->fifo_size) ?
  390. (OMAP_I2C_IE_RDR | OMAP_I2C_IE_XDR) : 0);
  391. dev->pscstate = psc;
  392. dev->scllstate = scll;
  393. dev->sclhstate = sclh;
  394. __omap_i2c_init(dev);
  395. return 0;
  396. }
  397. /*
  398. * Waiting on Bus Busy
  399. */
  400. static int omap_i2c_wait_for_bb(struct omap_i2c_dev *dev)
  401. {
  402. unsigned long timeout;
  403. timeout = jiffies + OMAP_I2C_TIMEOUT;
  404. while (omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG) & OMAP_I2C_STAT_BB) {
  405. if (time_after(jiffies, timeout)) {
  406. dev_warn(dev->dev, "timeout waiting for bus ready\n");
  407. return -ETIMEDOUT;
  408. }
  409. msleep(1);
  410. }
  411. return 0;
  412. }
  413. static void omap_i2c_resize_fifo(struct omap_i2c_dev *dev, u8 size, bool is_rx)
  414. {
  415. u16 buf;
  416. if (dev->flags & OMAP_I2C_FLAG_NO_FIFO)
  417. return;
  418. /*
  419. * Set up notification threshold based on message size. We're doing
  420. * this to try and avoid draining feature as much as possible. Whenever
  421. * we have big messages to transfer (bigger than our total fifo size)
  422. * then we might use draining feature to transfer the remaining bytes.
  423. */
  424. dev->threshold = clamp(size, (u8) 1, dev->fifo_size);
  425. buf = omap_i2c_read_reg(dev, OMAP_I2C_BUF_REG);
  426. if (is_rx) {
  427. /* Clear RX Threshold */
  428. buf &= ~(0x3f << 8);
  429. buf |= ((dev->threshold - 1) << 8) | OMAP_I2C_BUF_RXFIF_CLR;
  430. } else {
  431. /* Clear TX Threshold */
  432. buf &= ~0x3f;
  433. buf |= (dev->threshold - 1) | OMAP_I2C_BUF_TXFIF_CLR;
  434. }
  435. omap_i2c_write_reg(dev, OMAP_I2C_BUF_REG, buf);
  436. if (dev->rev < OMAP_I2C_REV_ON_3630)
  437. dev->b_hw = 1; /* Enable hardware fixes */
  438. /* calculate wakeup latency constraint for MPU */
  439. if (dev->set_mpu_wkup_lat != NULL)
  440. dev->latency = (1000000 * dev->threshold) /
  441. (1000 * dev->speed / 8);
  442. }
  443. /*
  444. * Low level master read/write transaction.
  445. */
  446. static int omap_i2c_xfer_msg(struct i2c_adapter *adap,
  447. struct i2c_msg *msg, int stop)
  448. {
  449. struct omap_i2c_dev *dev = i2c_get_adapdata(adap);
  450. unsigned long timeout;
  451. u16 w;
  452. dev_dbg(dev->dev, "addr: 0x%04x, len: %d, flags: 0x%x, stop: %d\n",
  453. msg->addr, msg->len, msg->flags, stop);
  454. if (msg->len == 0)
  455. return -EINVAL;
  456. dev->receiver = !!(msg->flags & I2C_M_RD);
  457. omap_i2c_resize_fifo(dev, msg->len, dev->receiver);
  458. omap_i2c_write_reg(dev, OMAP_I2C_SA_REG, msg->addr);
  459. /* REVISIT: Could the STB bit of I2C_CON be used with probing? */
  460. dev->buf = msg->buf;
  461. dev->buf_len = msg->len;
  462. /* make sure writes to dev->buf_len are ordered */
  463. barrier();
  464. omap_i2c_write_reg(dev, OMAP_I2C_CNT_REG, dev->buf_len);
  465. /* Clear the FIFO Buffers */
  466. w = omap_i2c_read_reg(dev, OMAP_I2C_BUF_REG);
  467. w |= OMAP_I2C_BUF_RXFIF_CLR | OMAP_I2C_BUF_TXFIF_CLR;
  468. omap_i2c_write_reg(dev, OMAP_I2C_BUF_REG, w);
  469. reinit_completion(&dev->cmd_complete);
  470. dev->cmd_err = 0;
  471. w = OMAP_I2C_CON_EN | OMAP_I2C_CON_MST | OMAP_I2C_CON_STT;
  472. /* High speed configuration */
  473. if (dev->speed > 400)
  474. w |= OMAP_I2C_CON_OPMODE_HS;
  475. if (msg->flags & I2C_M_STOP)
  476. stop = 1;
  477. if (msg->flags & I2C_M_TEN)
  478. w |= OMAP_I2C_CON_XA;
  479. if (!(msg->flags & I2C_M_RD))
  480. w |= OMAP_I2C_CON_TRX;
  481. if (!dev->b_hw && stop)
  482. w |= OMAP_I2C_CON_STP;
  483. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
  484. /*
  485. * Don't write stt and stp together on some hardware.
  486. */
  487. if (dev->b_hw && stop) {
  488. unsigned long delay = jiffies + OMAP_I2C_TIMEOUT;
  489. u16 con = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
  490. while (con & OMAP_I2C_CON_STT) {
  491. con = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
  492. /* Let the user know if i2c is in a bad state */
  493. if (time_after(jiffies, delay)) {
  494. dev_err(dev->dev, "controller timed out "
  495. "waiting for start condition to finish\n");
  496. return -ETIMEDOUT;
  497. }
  498. cpu_relax();
  499. }
  500. w |= OMAP_I2C_CON_STP;
  501. w &= ~OMAP_I2C_CON_STT;
  502. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
  503. }
  504. /*
  505. * REVISIT: We should abort the transfer on signals, but the bus goes
  506. * into arbitration and we're currently unable to recover from it.
  507. */
  508. timeout = wait_for_completion_timeout(&dev->cmd_complete,
  509. OMAP_I2C_TIMEOUT);
  510. if (timeout == 0) {
  511. dev_err(dev->dev, "controller timed out\n");
  512. omap_i2c_reset(dev);
  513. __omap_i2c_init(dev);
  514. return -ETIMEDOUT;
  515. }
  516. if (likely(!dev->cmd_err))
  517. return 0;
  518. /* We have an error */
  519. if (dev->cmd_err & (OMAP_I2C_STAT_AL | OMAP_I2C_STAT_ROVR |
  520. OMAP_I2C_STAT_XUDF)) {
  521. omap_i2c_reset(dev);
  522. __omap_i2c_init(dev);
  523. return -EIO;
  524. }
  525. if (dev->cmd_err & OMAP_I2C_STAT_NACK) {
  526. if (msg->flags & I2C_M_IGNORE_NAK)
  527. return 0;
  528. w = omap_i2c_read_reg(dev, OMAP_I2C_CON_REG);
  529. w |= OMAP_I2C_CON_STP;
  530. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, w);
  531. return -EREMOTEIO;
  532. }
  533. return -EIO;
  534. }
  535. /*
  536. * Prepare controller for a transaction and call omap_i2c_xfer_msg
  537. * to do the work during IRQ processing.
  538. */
  539. static int
  540. omap_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
  541. {
  542. struct omap_i2c_dev *dev = i2c_get_adapdata(adap);
  543. int i;
  544. int r;
  545. r = pm_runtime_get_sync(dev->dev);
  546. if (r < 0)
  547. goto out;
  548. r = omap_i2c_wait_for_bb(dev);
  549. if (r < 0)
  550. goto out;
  551. if (dev->set_mpu_wkup_lat != NULL)
  552. dev->set_mpu_wkup_lat(dev->dev, dev->latency);
  553. for (i = 0; i < num; i++) {
  554. r = omap_i2c_xfer_msg(adap, &msgs[i], (i == (num - 1)));
  555. if (r != 0)
  556. break;
  557. }
  558. if (r == 0)
  559. r = num;
  560. omap_i2c_wait_for_bb(dev);
  561. if (dev->set_mpu_wkup_lat != NULL)
  562. dev->set_mpu_wkup_lat(dev->dev, -1);
  563. out:
  564. pm_runtime_mark_last_busy(dev->dev);
  565. pm_runtime_put_autosuspend(dev->dev);
  566. return r;
  567. }
  568. static u32
  569. omap_i2c_func(struct i2c_adapter *adap)
  570. {
  571. return I2C_FUNC_I2C | (I2C_FUNC_SMBUS_EMUL & ~I2C_FUNC_SMBUS_QUICK) |
  572. I2C_FUNC_PROTOCOL_MANGLING;
  573. }
  574. static inline void
  575. omap_i2c_complete_cmd(struct omap_i2c_dev *dev, u16 err)
  576. {
  577. dev->cmd_err |= err;
  578. complete(&dev->cmd_complete);
  579. }
  580. static inline void
  581. omap_i2c_ack_stat(struct omap_i2c_dev *dev, u16 stat)
  582. {
  583. omap_i2c_write_reg(dev, OMAP_I2C_STAT_REG, stat);
  584. }
  585. static inline void i2c_omap_errata_i207(struct omap_i2c_dev *dev, u16 stat)
  586. {
  587. /*
  588. * I2C Errata(Errata Nos. OMAP2: 1.67, OMAP3: 1.8)
  589. * Not applicable for OMAP4.
  590. * Under certain rare conditions, RDR could be set again
  591. * when the bus is busy, then ignore the interrupt and
  592. * clear the interrupt.
  593. */
  594. if (stat & OMAP_I2C_STAT_RDR) {
  595. /* Step 1: If RDR is set, clear it */
  596. omap_i2c_ack_stat(dev, OMAP_I2C_STAT_RDR);
  597. /* Step 2: */
  598. if (!(omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG)
  599. & OMAP_I2C_STAT_BB)) {
  600. /* Step 3: */
  601. if (omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG)
  602. & OMAP_I2C_STAT_RDR) {
  603. omap_i2c_ack_stat(dev, OMAP_I2C_STAT_RDR);
  604. dev_dbg(dev->dev, "RDR when bus is busy.\n");
  605. }
  606. }
  607. }
  608. }
  609. /* rev1 devices are apparently only on some 15xx */
  610. #ifdef CONFIG_ARCH_OMAP15XX
  611. static irqreturn_t
  612. omap_i2c_omap1_isr(int this_irq, void *dev_id)
  613. {
  614. struct omap_i2c_dev *dev = dev_id;
  615. u16 iv, w;
  616. if (pm_runtime_suspended(dev->dev))
  617. return IRQ_NONE;
  618. iv = omap_i2c_read_reg(dev, OMAP_I2C_IV_REG);
  619. switch (iv) {
  620. case 0x00: /* None */
  621. break;
  622. case 0x01: /* Arbitration lost */
  623. dev_err(dev->dev, "Arbitration lost\n");
  624. omap_i2c_complete_cmd(dev, OMAP_I2C_STAT_AL);
  625. break;
  626. case 0x02: /* No acknowledgement */
  627. omap_i2c_complete_cmd(dev, OMAP_I2C_STAT_NACK);
  628. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, OMAP_I2C_CON_STP);
  629. break;
  630. case 0x03: /* Register access ready */
  631. omap_i2c_complete_cmd(dev, 0);
  632. break;
  633. case 0x04: /* Receive data ready */
  634. if (dev->buf_len) {
  635. w = omap_i2c_read_reg(dev, OMAP_I2C_DATA_REG);
  636. *dev->buf++ = w;
  637. dev->buf_len--;
  638. if (dev->buf_len) {
  639. *dev->buf++ = w >> 8;
  640. dev->buf_len--;
  641. }
  642. } else
  643. dev_err(dev->dev, "RRDY IRQ while no data requested\n");
  644. break;
  645. case 0x05: /* Transmit data ready */
  646. if (dev->buf_len) {
  647. w = *dev->buf++;
  648. dev->buf_len--;
  649. if (dev->buf_len) {
  650. w |= *dev->buf++ << 8;
  651. dev->buf_len--;
  652. }
  653. omap_i2c_write_reg(dev, OMAP_I2C_DATA_REG, w);
  654. } else
  655. dev_err(dev->dev, "XRDY IRQ while no data to send\n");
  656. break;
  657. default:
  658. return IRQ_NONE;
  659. }
  660. return IRQ_HANDLED;
  661. }
  662. #else
  663. #define omap_i2c_omap1_isr NULL
  664. #endif
  665. /*
  666. * OMAP3430 Errata i462: When an XRDY/XDR is hit, wait for XUDF before writing
  667. * data to DATA_REG. Otherwise some data bytes can be lost while transferring
  668. * them from the memory to the I2C interface.
  669. */
  670. static int errata_omap3_i462(struct omap_i2c_dev *dev)
  671. {
  672. unsigned long timeout = 10000;
  673. u16 stat;
  674. do {
  675. stat = omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG);
  676. if (stat & OMAP_I2C_STAT_XUDF)
  677. break;
  678. if (stat & (OMAP_I2C_STAT_NACK | OMAP_I2C_STAT_AL)) {
  679. omap_i2c_ack_stat(dev, (OMAP_I2C_STAT_XRDY |
  680. OMAP_I2C_STAT_XDR));
  681. if (stat & OMAP_I2C_STAT_NACK) {
  682. dev->cmd_err |= OMAP_I2C_STAT_NACK;
  683. omap_i2c_ack_stat(dev, OMAP_I2C_STAT_NACK);
  684. }
  685. if (stat & OMAP_I2C_STAT_AL) {
  686. dev_err(dev->dev, "Arbitration lost\n");
  687. dev->cmd_err |= OMAP_I2C_STAT_AL;
  688. omap_i2c_ack_stat(dev, OMAP_I2C_STAT_AL);
  689. }
  690. return -EIO;
  691. }
  692. cpu_relax();
  693. } while (--timeout);
  694. if (!timeout) {
  695. dev_err(dev->dev, "timeout waiting on XUDF bit\n");
  696. return 0;
  697. }
  698. return 0;
  699. }
  700. static void omap_i2c_receive_data(struct omap_i2c_dev *dev, u8 num_bytes,
  701. bool is_rdr)
  702. {
  703. u16 w;
  704. while (num_bytes--) {
  705. w = omap_i2c_read_reg(dev, OMAP_I2C_DATA_REG);
  706. *dev->buf++ = w;
  707. dev->buf_len--;
  708. /*
  709. * Data reg in 2430, omap3 and
  710. * omap4 is 8 bit wide
  711. */
  712. if (dev->flags & OMAP_I2C_FLAG_16BIT_DATA_REG) {
  713. *dev->buf++ = w >> 8;
  714. dev->buf_len--;
  715. }
  716. }
  717. }
  718. static int omap_i2c_transmit_data(struct omap_i2c_dev *dev, u8 num_bytes,
  719. bool is_xdr)
  720. {
  721. u16 w;
  722. while (num_bytes--) {
  723. w = *dev->buf++;
  724. dev->buf_len--;
  725. /*
  726. * Data reg in 2430, omap3 and
  727. * omap4 is 8 bit wide
  728. */
  729. if (dev->flags & OMAP_I2C_FLAG_16BIT_DATA_REG) {
  730. w |= *dev->buf++ << 8;
  731. dev->buf_len--;
  732. }
  733. if (dev->errata & I2C_OMAP_ERRATA_I462) {
  734. int ret;
  735. ret = errata_omap3_i462(dev);
  736. if (ret < 0)
  737. return ret;
  738. }
  739. omap_i2c_write_reg(dev, OMAP_I2C_DATA_REG, w);
  740. }
  741. return 0;
  742. }
  743. static irqreturn_t
  744. omap_i2c_isr(int irq, void *dev_id)
  745. {
  746. struct omap_i2c_dev *dev = dev_id;
  747. irqreturn_t ret = IRQ_HANDLED;
  748. u16 mask;
  749. u16 stat;
  750. spin_lock(&dev->lock);
  751. mask = omap_i2c_read_reg(dev, OMAP_I2C_IE_REG);
  752. stat = omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG);
  753. if (stat & mask)
  754. ret = IRQ_WAKE_THREAD;
  755. spin_unlock(&dev->lock);
  756. return ret;
  757. }
  758. static irqreturn_t
  759. omap_i2c_isr_thread(int this_irq, void *dev_id)
  760. {
  761. struct omap_i2c_dev *dev = dev_id;
  762. unsigned long flags;
  763. u16 bits;
  764. u16 stat;
  765. int err = 0, count = 0;
  766. spin_lock_irqsave(&dev->lock, flags);
  767. do {
  768. bits = omap_i2c_read_reg(dev, OMAP_I2C_IE_REG);
  769. stat = omap_i2c_read_reg(dev, OMAP_I2C_STAT_REG);
  770. stat &= bits;
  771. /* If we're in receiver mode, ignore XDR/XRDY */
  772. if (dev->receiver)
  773. stat &= ~(OMAP_I2C_STAT_XDR | OMAP_I2C_STAT_XRDY);
  774. else
  775. stat &= ~(OMAP_I2C_STAT_RDR | OMAP_I2C_STAT_RRDY);
  776. if (!stat) {
  777. /* my work here is done */
  778. goto out;
  779. }
  780. dev_dbg(dev->dev, "IRQ (ISR = 0x%04x)\n", stat);
  781. if (count++ == 100) {
  782. dev_warn(dev->dev, "Too much work in one IRQ\n");
  783. break;
  784. }
  785. if (stat & OMAP_I2C_STAT_NACK) {
  786. err |= OMAP_I2C_STAT_NACK;
  787. omap_i2c_ack_stat(dev, OMAP_I2C_STAT_NACK);
  788. break;
  789. }
  790. if (stat & OMAP_I2C_STAT_AL) {
  791. dev_err(dev->dev, "Arbitration lost\n");
  792. err |= OMAP_I2C_STAT_AL;
  793. omap_i2c_ack_stat(dev, OMAP_I2C_STAT_AL);
  794. break;
  795. }
  796. /*
  797. * ProDB0017052: Clear ARDY bit twice
  798. */
  799. if (stat & OMAP_I2C_STAT_ARDY)
  800. omap_i2c_ack_stat(dev, OMAP_I2C_STAT_ARDY);
  801. if (stat & (OMAP_I2C_STAT_ARDY | OMAP_I2C_STAT_NACK |
  802. OMAP_I2C_STAT_AL)) {
  803. omap_i2c_ack_stat(dev, (OMAP_I2C_STAT_RRDY |
  804. OMAP_I2C_STAT_RDR |
  805. OMAP_I2C_STAT_XRDY |
  806. OMAP_I2C_STAT_XDR |
  807. OMAP_I2C_STAT_ARDY));
  808. break;
  809. }
  810. if (stat & OMAP_I2C_STAT_RDR) {
  811. u8 num_bytes = 1;
  812. if (dev->fifo_size)
  813. num_bytes = dev->buf_len;
  814. omap_i2c_receive_data(dev, num_bytes, true);
  815. if (dev->errata & I2C_OMAP_ERRATA_I207)
  816. i2c_omap_errata_i207(dev, stat);
  817. omap_i2c_ack_stat(dev, OMAP_I2C_STAT_RDR);
  818. continue;
  819. }
  820. if (stat & OMAP_I2C_STAT_RRDY) {
  821. u8 num_bytes = 1;
  822. if (dev->threshold)
  823. num_bytes = dev->threshold;
  824. omap_i2c_receive_data(dev, num_bytes, false);
  825. omap_i2c_ack_stat(dev, OMAP_I2C_STAT_RRDY);
  826. continue;
  827. }
  828. if (stat & OMAP_I2C_STAT_XDR) {
  829. u8 num_bytes = 1;
  830. int ret;
  831. if (dev->fifo_size)
  832. num_bytes = dev->buf_len;
  833. ret = omap_i2c_transmit_data(dev, num_bytes, true);
  834. if (ret < 0)
  835. break;
  836. omap_i2c_ack_stat(dev, OMAP_I2C_STAT_XDR);
  837. continue;
  838. }
  839. if (stat & OMAP_I2C_STAT_XRDY) {
  840. u8 num_bytes = 1;
  841. int ret;
  842. if (dev->threshold)
  843. num_bytes = dev->threshold;
  844. ret = omap_i2c_transmit_data(dev, num_bytes, false);
  845. if (ret < 0)
  846. break;
  847. omap_i2c_ack_stat(dev, OMAP_I2C_STAT_XRDY);
  848. continue;
  849. }
  850. if (stat & OMAP_I2C_STAT_ROVR) {
  851. dev_err(dev->dev, "Receive overrun\n");
  852. err |= OMAP_I2C_STAT_ROVR;
  853. omap_i2c_ack_stat(dev, OMAP_I2C_STAT_ROVR);
  854. break;
  855. }
  856. if (stat & OMAP_I2C_STAT_XUDF) {
  857. dev_err(dev->dev, "Transmit underflow\n");
  858. err |= OMAP_I2C_STAT_XUDF;
  859. omap_i2c_ack_stat(dev, OMAP_I2C_STAT_XUDF);
  860. break;
  861. }
  862. } while (stat);
  863. omap_i2c_complete_cmd(dev, err);
  864. out:
  865. spin_unlock_irqrestore(&dev->lock, flags);
  866. return IRQ_HANDLED;
  867. }
  868. static const struct i2c_algorithm omap_i2c_algo = {
  869. .master_xfer = omap_i2c_xfer,
  870. .functionality = omap_i2c_func,
  871. };
  872. #ifdef CONFIG_OF
  873. static struct omap_i2c_bus_platform_data omap2420_pdata = {
  874. .rev = OMAP_I2C_IP_VERSION_1,
  875. .flags = OMAP_I2C_FLAG_NO_FIFO |
  876. OMAP_I2C_FLAG_SIMPLE_CLOCK |
  877. OMAP_I2C_FLAG_16BIT_DATA_REG |
  878. OMAP_I2C_FLAG_BUS_SHIFT_2,
  879. };
  880. static struct omap_i2c_bus_platform_data omap2430_pdata = {
  881. .rev = OMAP_I2C_IP_VERSION_1,
  882. .flags = OMAP_I2C_FLAG_BUS_SHIFT_2 |
  883. OMAP_I2C_FLAG_FORCE_19200_INT_CLK,
  884. };
  885. static struct omap_i2c_bus_platform_data omap3_pdata = {
  886. .rev = OMAP_I2C_IP_VERSION_1,
  887. .flags = OMAP_I2C_FLAG_BUS_SHIFT_2,
  888. };
  889. static struct omap_i2c_bus_platform_data omap4_pdata = {
  890. .rev = OMAP_I2C_IP_VERSION_2,
  891. };
  892. static const struct of_device_id omap_i2c_of_match[] = {
  893. {
  894. .compatible = "ti,omap4-i2c",
  895. .data = &omap4_pdata,
  896. },
  897. {
  898. .compatible = "ti,omap3-i2c",
  899. .data = &omap3_pdata,
  900. },
  901. {
  902. .compatible = "ti,omap2430-i2c",
  903. .data = &omap2430_pdata,
  904. },
  905. {
  906. .compatible = "ti,omap2420-i2c",
  907. .data = &omap2420_pdata,
  908. },
  909. { },
  910. };
  911. MODULE_DEVICE_TABLE(of, omap_i2c_of_match);
  912. #endif
  913. #define OMAP_I2C_SCHEME(rev) ((rev & 0xc000) >> 14)
  914. #define OMAP_I2C_REV_SCHEME_0_MAJOR(rev) (rev >> 4)
  915. #define OMAP_I2C_REV_SCHEME_0_MINOR(rev) (rev & 0xf)
  916. #define OMAP_I2C_REV_SCHEME_1_MAJOR(rev) ((rev & 0x0700) >> 7)
  917. #define OMAP_I2C_REV_SCHEME_1_MINOR(rev) (rev & 0x1f)
  918. #define OMAP_I2C_SCHEME_0 0
  919. #define OMAP_I2C_SCHEME_1 1
  920. static int
  921. omap_i2c_probe(struct platform_device *pdev)
  922. {
  923. struct omap_i2c_dev *dev;
  924. struct i2c_adapter *adap;
  925. struct resource *mem;
  926. const struct omap_i2c_bus_platform_data *pdata =
  927. dev_get_platdata(&pdev->dev);
  928. struct device_node *node = pdev->dev.of_node;
  929. const struct of_device_id *match;
  930. int irq;
  931. int r;
  932. u32 rev;
  933. u16 minor, major;
  934. irq = platform_get_irq(pdev, 0);
  935. if (irq < 0) {
  936. dev_err(&pdev->dev, "no irq resource?\n");
  937. return irq;
  938. }
  939. dev = devm_kzalloc(&pdev->dev, sizeof(struct omap_i2c_dev), GFP_KERNEL);
  940. if (!dev)
  941. return -ENOMEM;
  942. mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  943. dev->base = devm_ioremap_resource(&pdev->dev, mem);
  944. if (IS_ERR(dev->base))
  945. return PTR_ERR(dev->base);
  946. match = of_match_device(of_match_ptr(omap_i2c_of_match), &pdev->dev);
  947. if (match) {
  948. u32 freq = 100000; /* default to 100000 Hz */
  949. pdata = match->data;
  950. dev->flags = pdata->flags;
  951. of_property_read_u32(node, "clock-frequency", &freq);
  952. /* convert DT freq value in Hz into kHz for speed */
  953. dev->speed = freq / 1000;
  954. } else if (pdata != NULL) {
  955. dev->speed = pdata->clkrate;
  956. dev->flags = pdata->flags;
  957. dev->set_mpu_wkup_lat = pdata->set_mpu_wkup_lat;
  958. }
  959. dev->dev = &pdev->dev;
  960. dev->irq = irq;
  961. spin_lock_init(&dev->lock);
  962. platform_set_drvdata(pdev, dev);
  963. init_completion(&dev->cmd_complete);
  964. dev->reg_shift = (dev->flags >> OMAP_I2C_FLAG_BUS_SHIFT__SHIFT) & 3;
  965. pm_runtime_enable(dev->dev);
  966. pm_runtime_set_autosuspend_delay(dev->dev, OMAP_I2C_PM_TIMEOUT);
  967. pm_runtime_use_autosuspend(dev->dev);
  968. r = pm_runtime_get_sync(dev->dev);
  969. if (r < 0)
  970. goto err_free_mem;
  971. /*
  972. * Read the Rev hi bit-[15:14] ie scheme this is 1 indicates ver2.
  973. * On omap1/3/2 Offset 4 is IE Reg the bit [15:14] is 0 at reset.
  974. * Also since the omap_i2c_read_reg uses reg_map_ip_* a
  975. * readw_relaxed is done.
  976. */
  977. rev = readw_relaxed(dev->base + 0x04);
  978. dev->scheme = OMAP_I2C_SCHEME(rev);
  979. switch (dev->scheme) {
  980. case OMAP_I2C_SCHEME_0:
  981. dev->regs = (u8 *)reg_map_ip_v1;
  982. dev->rev = omap_i2c_read_reg(dev, OMAP_I2C_REV_REG);
  983. minor = OMAP_I2C_REV_SCHEME_0_MAJOR(dev->rev);
  984. major = OMAP_I2C_REV_SCHEME_0_MAJOR(dev->rev);
  985. break;
  986. case OMAP_I2C_SCHEME_1:
  987. /* FALLTHROUGH */
  988. default:
  989. dev->regs = (u8 *)reg_map_ip_v2;
  990. rev = (rev << 16) |
  991. omap_i2c_read_reg(dev, OMAP_I2C_IP_V2_REVNB_LO);
  992. minor = OMAP_I2C_REV_SCHEME_1_MINOR(rev);
  993. major = OMAP_I2C_REV_SCHEME_1_MAJOR(rev);
  994. dev->rev = rev;
  995. }
  996. dev->errata = 0;
  997. if (dev->rev >= OMAP_I2C_REV_ON_2430 &&
  998. dev->rev < OMAP_I2C_REV_ON_4430_PLUS)
  999. dev->errata |= I2C_OMAP_ERRATA_I207;
  1000. if (dev->rev <= OMAP_I2C_REV_ON_3430_3530)
  1001. dev->errata |= I2C_OMAP_ERRATA_I462;
  1002. if (!(dev->flags & OMAP_I2C_FLAG_NO_FIFO)) {
  1003. u16 s;
  1004. /* Set up the fifo size - Get total size */
  1005. s = (omap_i2c_read_reg(dev, OMAP_I2C_BUFSTAT_REG) >> 14) & 0x3;
  1006. dev->fifo_size = 0x8 << s;
  1007. /*
  1008. * Set up notification threshold as half the total available
  1009. * size. This is to ensure that we can handle the status on int
  1010. * call back latencies.
  1011. */
  1012. dev->fifo_size = (dev->fifo_size / 2);
  1013. if (dev->rev < OMAP_I2C_REV_ON_3630)
  1014. dev->b_hw = 1; /* Enable hardware fixes */
  1015. /* calculate wakeup latency constraint for MPU */
  1016. if (dev->set_mpu_wkup_lat != NULL)
  1017. dev->latency = (1000000 * dev->fifo_size) /
  1018. (1000 * dev->speed / 8);
  1019. }
  1020. /* reset ASAP, clearing any IRQs */
  1021. omap_i2c_init(dev);
  1022. if (dev->rev < OMAP_I2C_OMAP1_REV_2)
  1023. r = devm_request_irq(&pdev->dev, dev->irq, omap_i2c_omap1_isr,
  1024. IRQF_NO_SUSPEND, pdev->name, dev);
  1025. else
  1026. r = devm_request_threaded_irq(&pdev->dev, dev->irq,
  1027. omap_i2c_isr, omap_i2c_isr_thread,
  1028. IRQF_NO_SUSPEND | IRQF_ONESHOT,
  1029. pdev->name, dev);
  1030. if (r) {
  1031. dev_err(dev->dev, "failure requesting irq %i\n", dev->irq);
  1032. goto err_unuse_clocks;
  1033. }
  1034. adap = &dev->adapter;
  1035. i2c_set_adapdata(adap, dev);
  1036. adap->owner = THIS_MODULE;
  1037. adap->class = I2C_CLASS_DEPRECATED;
  1038. strlcpy(adap->name, "OMAP I2C adapter", sizeof(adap->name));
  1039. adap->algo = &omap_i2c_algo;
  1040. adap->dev.parent = &pdev->dev;
  1041. adap->dev.of_node = pdev->dev.of_node;
  1042. /* i2c device drivers may be active on return from add_adapter() */
  1043. adap->nr = pdev->id;
  1044. r = i2c_add_numbered_adapter(adap);
  1045. if (r) {
  1046. dev_err(dev->dev, "failure adding adapter\n");
  1047. goto err_unuse_clocks;
  1048. }
  1049. dev_info(dev->dev, "bus %d rev%d.%d at %d kHz\n", adap->nr,
  1050. major, minor, dev->speed);
  1051. pm_runtime_mark_last_busy(dev->dev);
  1052. pm_runtime_put_autosuspend(dev->dev);
  1053. return 0;
  1054. err_unuse_clocks:
  1055. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
  1056. pm_runtime_put(dev->dev);
  1057. pm_runtime_disable(&pdev->dev);
  1058. err_free_mem:
  1059. return r;
  1060. }
  1061. static int omap_i2c_remove(struct platform_device *pdev)
  1062. {
  1063. struct omap_i2c_dev *dev = platform_get_drvdata(pdev);
  1064. int ret;
  1065. i2c_del_adapter(&dev->adapter);
  1066. ret = pm_runtime_get_sync(&pdev->dev);
  1067. if (ret < 0)
  1068. return ret;
  1069. omap_i2c_write_reg(dev, OMAP_I2C_CON_REG, 0);
  1070. pm_runtime_put(&pdev->dev);
  1071. pm_runtime_disable(&pdev->dev);
  1072. return 0;
  1073. }
  1074. #ifdef CONFIG_PM
  1075. #ifdef CONFIG_PM_RUNTIME
  1076. static int omap_i2c_runtime_suspend(struct device *dev)
  1077. {
  1078. struct platform_device *pdev = to_platform_device(dev);
  1079. struct omap_i2c_dev *_dev = platform_get_drvdata(pdev);
  1080. _dev->iestate = omap_i2c_read_reg(_dev, OMAP_I2C_IE_REG);
  1081. if (_dev->scheme == OMAP_I2C_SCHEME_0)
  1082. omap_i2c_write_reg(_dev, OMAP_I2C_IE_REG, 0);
  1083. else
  1084. omap_i2c_write_reg(_dev, OMAP_I2C_IP_V2_IRQENABLE_CLR,
  1085. OMAP_I2C_IP_V2_INTERRUPTS_MASK);
  1086. if (_dev->rev < OMAP_I2C_OMAP1_REV_2) {
  1087. omap_i2c_read_reg(_dev, OMAP_I2C_IV_REG); /* Read clears */
  1088. } else {
  1089. omap_i2c_write_reg(_dev, OMAP_I2C_STAT_REG, _dev->iestate);
  1090. /* Flush posted write */
  1091. omap_i2c_read_reg(_dev, OMAP_I2C_STAT_REG);
  1092. }
  1093. return 0;
  1094. }
  1095. static int omap_i2c_runtime_resume(struct device *dev)
  1096. {
  1097. struct platform_device *pdev = to_platform_device(dev);
  1098. struct omap_i2c_dev *_dev = platform_get_drvdata(pdev);
  1099. if (!_dev->regs)
  1100. return 0;
  1101. __omap_i2c_init(_dev);
  1102. return 0;
  1103. }
  1104. #endif /* CONFIG_PM_RUNTIME */
  1105. static struct dev_pm_ops omap_i2c_pm_ops = {
  1106. SET_RUNTIME_PM_OPS(omap_i2c_runtime_suspend,
  1107. omap_i2c_runtime_resume, NULL)
  1108. };
  1109. #define OMAP_I2C_PM_OPS (&omap_i2c_pm_ops)
  1110. #else
  1111. #define OMAP_I2C_PM_OPS NULL
  1112. #endif /* CONFIG_PM */
  1113. static struct platform_driver omap_i2c_driver = {
  1114. .probe = omap_i2c_probe,
  1115. .remove = omap_i2c_remove,
  1116. .driver = {
  1117. .name = "omap_i2c",
  1118. .owner = THIS_MODULE,
  1119. .pm = OMAP_I2C_PM_OPS,
  1120. .of_match_table = of_match_ptr(omap_i2c_of_match),
  1121. },
  1122. };
  1123. /* I2C may be needed to bring up other drivers */
  1124. static int __init
  1125. omap_i2c_init_driver(void)
  1126. {
  1127. return platform_driver_register(&omap_i2c_driver);
  1128. }
  1129. subsys_initcall(omap_i2c_init_driver);
  1130. static void __exit omap_i2c_exit_driver(void)
  1131. {
  1132. platform_driver_unregister(&omap_i2c_driver);
  1133. }
  1134. module_exit(omap_i2c_exit_driver);
  1135. MODULE_AUTHOR("MontaVista Software, Inc. (and others)");
  1136. MODULE_DESCRIPTION("TI OMAP I2C bus adapter");
  1137. MODULE_LICENSE("GPL");
  1138. MODULE_ALIAS("platform:omap_i2c");