i2c-davinci.c 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984
  1. /*
  2. * TI DAVINCI I2C adapter driver.
  3. *
  4. * Copyright (C) 2006 Texas Instruments.
  5. * Copyright (C) 2007 MontaVista Software Inc.
  6. *
  7. * Updated by Vinod & Sudhakar Feb 2005
  8. *
  9. * ----------------------------------------------------------------------------
  10. *
  11. * This program is free software; you can redistribute it and/or modify
  12. * it under the terms of the GNU General Public License as published by
  13. * the Free Software Foundation; either version 2 of the License, or
  14. * (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU General Public License for more details.
  20. * ----------------------------------------------------------------------------
  21. *
  22. */
  23. #include <linux/kernel.h>
  24. #include <linux/module.h>
  25. #include <linux/delay.h>
  26. #include <linux/i2c.h>
  27. #include <linux/clk.h>
  28. #include <linux/errno.h>
  29. #include <linux/sched.h>
  30. #include <linux/err.h>
  31. #include <linux/interrupt.h>
  32. #include <linux/platform_device.h>
  33. #include <linux/io.h>
  34. #include <linux/slab.h>
  35. #include <linux/cpufreq.h>
  36. #include <linux/gpio.h>
  37. #include <linux/of_device.h>
  38. #include <linux/platform_data/i2c-davinci.h>
  39. #include <linux/pm_runtime.h>
  40. /* ----- global defines ----------------------------------------------- */
  41. #define DAVINCI_I2C_TIMEOUT (1*HZ)
  42. #define DAVINCI_I2C_MAX_TRIES 2
  43. #define DAVINCI_I2C_OWN_ADDRESS 0x08
  44. #define I2C_DAVINCI_INTR_ALL (DAVINCI_I2C_IMR_SCD | \
  45. DAVINCI_I2C_IMR_ARDY | \
  46. DAVINCI_I2C_IMR_NACK | \
  47. DAVINCI_I2C_IMR_AL)
  48. #define DAVINCI_I2C_OAR_REG 0x00
  49. #define DAVINCI_I2C_IMR_REG 0x04
  50. #define DAVINCI_I2C_STR_REG 0x08
  51. #define DAVINCI_I2C_CLKL_REG 0x0c
  52. #define DAVINCI_I2C_CLKH_REG 0x10
  53. #define DAVINCI_I2C_CNT_REG 0x14
  54. #define DAVINCI_I2C_DRR_REG 0x18
  55. #define DAVINCI_I2C_SAR_REG 0x1c
  56. #define DAVINCI_I2C_DXR_REG 0x20
  57. #define DAVINCI_I2C_MDR_REG 0x24
  58. #define DAVINCI_I2C_IVR_REG 0x28
  59. #define DAVINCI_I2C_EMDR_REG 0x2c
  60. #define DAVINCI_I2C_PSC_REG 0x30
  61. #define DAVINCI_I2C_FUNC_REG 0x48
  62. #define DAVINCI_I2C_DIR_REG 0x4c
  63. #define DAVINCI_I2C_DIN_REG 0x50
  64. #define DAVINCI_I2C_DOUT_REG 0x54
  65. #define DAVINCI_I2C_DSET_REG 0x58
  66. #define DAVINCI_I2C_DCLR_REG 0x5c
  67. #define DAVINCI_I2C_IVR_AAS 0x07
  68. #define DAVINCI_I2C_IVR_SCD 0x06
  69. #define DAVINCI_I2C_IVR_XRDY 0x05
  70. #define DAVINCI_I2C_IVR_RDR 0x04
  71. #define DAVINCI_I2C_IVR_ARDY 0x03
  72. #define DAVINCI_I2C_IVR_NACK 0x02
  73. #define DAVINCI_I2C_IVR_AL 0x01
  74. #define DAVINCI_I2C_STR_BB BIT(12)
  75. #define DAVINCI_I2C_STR_RSFULL BIT(11)
  76. #define DAVINCI_I2C_STR_SCD BIT(5)
  77. #define DAVINCI_I2C_STR_ARDY BIT(2)
  78. #define DAVINCI_I2C_STR_NACK BIT(1)
  79. #define DAVINCI_I2C_STR_AL BIT(0)
  80. #define DAVINCI_I2C_MDR_NACK BIT(15)
  81. #define DAVINCI_I2C_MDR_STT BIT(13)
  82. #define DAVINCI_I2C_MDR_STP BIT(11)
  83. #define DAVINCI_I2C_MDR_MST BIT(10)
  84. #define DAVINCI_I2C_MDR_TRX BIT(9)
  85. #define DAVINCI_I2C_MDR_XA BIT(8)
  86. #define DAVINCI_I2C_MDR_RM BIT(7)
  87. #define DAVINCI_I2C_MDR_IRS BIT(5)
  88. #define DAVINCI_I2C_IMR_AAS BIT(6)
  89. #define DAVINCI_I2C_IMR_SCD BIT(5)
  90. #define DAVINCI_I2C_IMR_XRDY BIT(4)
  91. #define DAVINCI_I2C_IMR_RRDY BIT(3)
  92. #define DAVINCI_I2C_IMR_ARDY BIT(2)
  93. #define DAVINCI_I2C_IMR_NACK BIT(1)
  94. #define DAVINCI_I2C_IMR_AL BIT(0)
  95. /* set SDA and SCL as GPIO */
  96. #define DAVINCI_I2C_FUNC_PFUNC0 BIT(0)
  97. /* set SCL as output when used as GPIO*/
  98. #define DAVINCI_I2C_DIR_PDIR0 BIT(0)
  99. /* set SDA as output when used as GPIO*/
  100. #define DAVINCI_I2C_DIR_PDIR1 BIT(1)
  101. /* read SCL GPIO level */
  102. #define DAVINCI_I2C_DIN_PDIN0 BIT(0)
  103. /* read SDA GPIO level */
  104. #define DAVINCI_I2C_DIN_PDIN1 BIT(1)
  105. /*set the SCL GPIO high */
  106. #define DAVINCI_I2C_DSET_PDSET0 BIT(0)
  107. /*set the SDA GPIO high */
  108. #define DAVINCI_I2C_DSET_PDSET1 BIT(1)
  109. /* set the SCL GPIO low */
  110. #define DAVINCI_I2C_DCLR_PDCLR0 BIT(0)
  111. /* set the SDA GPIO low */
  112. #define DAVINCI_I2C_DCLR_PDCLR1 BIT(1)
  113. /* timeout for pm runtime autosuspend */
  114. #define DAVINCI_I2C_PM_TIMEOUT 1000 /* ms */
  115. struct davinci_i2c_dev {
  116. struct device *dev;
  117. void __iomem *base;
  118. struct completion cmd_complete;
  119. struct clk *clk;
  120. int cmd_err;
  121. u8 *buf;
  122. size_t buf_len;
  123. int irq;
  124. int stop;
  125. u8 terminate;
  126. struct i2c_adapter adapter;
  127. #ifdef CONFIG_CPU_FREQ
  128. struct completion xfr_complete;
  129. struct notifier_block freq_transition;
  130. #endif
  131. struct davinci_i2c_platform_data *pdata;
  132. };
  133. /* default platform data to use if not supplied in the platform_device */
  134. static struct davinci_i2c_platform_data davinci_i2c_platform_data_default = {
  135. .bus_freq = 100,
  136. .bus_delay = 0,
  137. };
  138. static inline void davinci_i2c_write_reg(struct davinci_i2c_dev *i2c_dev,
  139. int reg, u16 val)
  140. {
  141. writew_relaxed(val, i2c_dev->base + reg);
  142. }
  143. static inline u16 davinci_i2c_read_reg(struct davinci_i2c_dev *i2c_dev, int reg)
  144. {
  145. return readw_relaxed(i2c_dev->base + reg);
  146. }
  147. static inline void davinci_i2c_reset_ctrl(struct davinci_i2c_dev *i2c_dev,
  148. int val)
  149. {
  150. u16 w;
  151. w = davinci_i2c_read_reg(i2c_dev, DAVINCI_I2C_MDR_REG);
  152. if (!val) /* put I2C into reset */
  153. w &= ~DAVINCI_I2C_MDR_IRS;
  154. else /* take I2C out of reset */
  155. w |= DAVINCI_I2C_MDR_IRS;
  156. davinci_i2c_write_reg(i2c_dev, DAVINCI_I2C_MDR_REG, w);
  157. }
  158. static void i2c_davinci_calc_clk_dividers(struct davinci_i2c_dev *dev)
  159. {
  160. struct davinci_i2c_platform_data *pdata = dev->pdata;
  161. u16 psc;
  162. u32 clk;
  163. u32 d;
  164. u32 clkh;
  165. u32 clkl;
  166. u32 input_clock = clk_get_rate(dev->clk);
  167. struct device_node *of_node = dev->dev->of_node;
  168. /* NOTE: I2C Clock divider programming info
  169. * As per I2C specs the following formulas provide prescaler
  170. * and low/high divider values
  171. * input clk --> PSC Div -----------> ICCL/H Div --> output clock
  172. * module clk
  173. *
  174. * output clk = module clk / (PSC + 1) [ (ICCL + d) + (ICCH + d) ]
  175. *
  176. * Thus,
  177. * (ICCL + ICCH) = clk = (input clk / ((psc +1) * output clk)) - 2d;
  178. *
  179. * where if PSC == 0, d = 7,
  180. * if PSC == 1, d = 6
  181. * if PSC > 1 , d = 5
  182. *
  183. * Note:
  184. * d is always 6 on Keystone I2C controller
  185. */
  186. /*
  187. * Both Davinci and current Keystone User Guides recommend a value
  188. * between 7MHz and 12MHz. In reality 7MHz module clock doesn't
  189. * always produce enough margin between SDA and SCL transitions.
  190. * Measurements show that the higher the module clock is, the
  191. * bigger is the margin, providing more reliable communication.
  192. * So we better target for 12MHz.
  193. */
  194. psc = (input_clock / 12000000) - 1;
  195. if ((input_clock / (psc + 1)) > 12000000)
  196. psc++; /* better to run under spec than over */
  197. d = (psc >= 2) ? 5 : 7 - psc;
  198. if (of_node && of_device_is_compatible(of_node, "ti,keystone-i2c"))
  199. d = 6;
  200. clk = ((input_clock / (psc + 1)) / (pdata->bus_freq * 1000));
  201. /* Avoid driving the bus too fast because of rounding errors above */
  202. if (input_clock / (psc + 1) / clk > pdata->bus_freq * 1000)
  203. clk++;
  204. /*
  205. * According to I2C-BUS Spec 2.1, in FAST-MODE LOW period should be at
  206. * least 1.3uS, which is not the case with 50% duty cycle. Driving HIGH
  207. * to LOW ratio as 1 to 2 is more safe.
  208. */
  209. if (pdata->bus_freq > 100)
  210. clkl = (clk << 1) / 3;
  211. else
  212. clkl = (clk >> 1);
  213. /*
  214. * It's not always possible to have 1 to 2 ratio when d=7, so fall back
  215. * to minimal possible clkh in this case.
  216. */
  217. if (clk >= clkl + d) {
  218. clkh = clk - clkl - d;
  219. clkl -= d;
  220. } else {
  221. clkh = 0;
  222. clkl = clk - (d << 1);
  223. }
  224. davinci_i2c_write_reg(dev, DAVINCI_I2C_PSC_REG, psc);
  225. davinci_i2c_write_reg(dev, DAVINCI_I2C_CLKH_REG, clkh);
  226. davinci_i2c_write_reg(dev, DAVINCI_I2C_CLKL_REG, clkl);
  227. dev_dbg(dev->dev, "input_clock = %d, CLK = %d\n", input_clock, clk);
  228. }
  229. /*
  230. * This function configures I2C and brings I2C out of reset.
  231. * This function is called during I2C init function. This function
  232. * also gets called if I2C encounters any errors.
  233. */
  234. static int i2c_davinci_init(struct davinci_i2c_dev *dev)
  235. {
  236. struct davinci_i2c_platform_data *pdata = dev->pdata;
  237. /* put I2C into reset */
  238. davinci_i2c_reset_ctrl(dev, 0);
  239. /* compute clock dividers */
  240. i2c_davinci_calc_clk_dividers(dev);
  241. /* Respond at reserved "SMBus Host" slave address" (and zero);
  242. * we seem to have no option to not respond...
  243. */
  244. davinci_i2c_write_reg(dev, DAVINCI_I2C_OAR_REG, DAVINCI_I2C_OWN_ADDRESS);
  245. dev_dbg(dev->dev, "PSC = %d\n",
  246. davinci_i2c_read_reg(dev, DAVINCI_I2C_PSC_REG));
  247. dev_dbg(dev->dev, "CLKL = %d\n",
  248. davinci_i2c_read_reg(dev, DAVINCI_I2C_CLKL_REG));
  249. dev_dbg(dev->dev, "CLKH = %d\n",
  250. davinci_i2c_read_reg(dev, DAVINCI_I2C_CLKH_REG));
  251. dev_dbg(dev->dev, "bus_freq = %dkHz, bus_delay = %d\n",
  252. pdata->bus_freq, pdata->bus_delay);
  253. /* Take the I2C module out of reset: */
  254. davinci_i2c_reset_ctrl(dev, 1);
  255. /* Enable interrupts */
  256. davinci_i2c_write_reg(dev, DAVINCI_I2C_IMR_REG, I2C_DAVINCI_INTR_ALL);
  257. return 0;
  258. }
  259. /*
  260. * This routine does i2c bus recovery by using i2c_generic_gpio_recovery
  261. * which is provided by I2C Bus recovery infrastructure.
  262. */
  263. static void davinci_i2c_prepare_recovery(struct i2c_adapter *adap)
  264. {
  265. struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
  266. /* Disable interrupts */
  267. davinci_i2c_write_reg(dev, DAVINCI_I2C_IMR_REG, 0);
  268. /* put I2C into reset */
  269. davinci_i2c_reset_ctrl(dev, 0);
  270. }
  271. static void davinci_i2c_unprepare_recovery(struct i2c_adapter *adap)
  272. {
  273. struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
  274. i2c_davinci_init(dev);
  275. }
  276. static struct i2c_bus_recovery_info davinci_i2c_gpio_recovery_info = {
  277. .recover_bus = i2c_generic_gpio_recovery,
  278. .prepare_recovery = davinci_i2c_prepare_recovery,
  279. .unprepare_recovery = davinci_i2c_unprepare_recovery,
  280. };
  281. static void davinci_i2c_set_scl(struct i2c_adapter *adap, int val)
  282. {
  283. struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
  284. if (val)
  285. davinci_i2c_write_reg(dev, DAVINCI_I2C_DSET_REG,
  286. DAVINCI_I2C_DSET_PDSET0);
  287. else
  288. davinci_i2c_write_reg(dev, DAVINCI_I2C_DCLR_REG,
  289. DAVINCI_I2C_DCLR_PDCLR0);
  290. }
  291. static int davinci_i2c_get_scl(struct i2c_adapter *adap)
  292. {
  293. struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
  294. int val;
  295. /* read the state of SCL */
  296. val = davinci_i2c_read_reg(dev, DAVINCI_I2C_DIN_REG);
  297. return val & DAVINCI_I2C_DIN_PDIN0;
  298. }
  299. static int davinci_i2c_get_sda(struct i2c_adapter *adap)
  300. {
  301. struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
  302. int val;
  303. /* read the state of SDA */
  304. val = davinci_i2c_read_reg(dev, DAVINCI_I2C_DIN_REG);
  305. return val & DAVINCI_I2C_DIN_PDIN1;
  306. }
  307. static void davinci_i2c_scl_prepare_recovery(struct i2c_adapter *adap)
  308. {
  309. struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
  310. davinci_i2c_prepare_recovery(adap);
  311. /* SCL output, SDA input */
  312. davinci_i2c_write_reg(dev, DAVINCI_I2C_DIR_REG, DAVINCI_I2C_DIR_PDIR0);
  313. /* change to GPIO mode */
  314. davinci_i2c_write_reg(dev, DAVINCI_I2C_FUNC_REG,
  315. DAVINCI_I2C_FUNC_PFUNC0);
  316. }
  317. static void davinci_i2c_scl_unprepare_recovery(struct i2c_adapter *adap)
  318. {
  319. struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
  320. /* change back to I2C mode */
  321. davinci_i2c_write_reg(dev, DAVINCI_I2C_FUNC_REG, 0);
  322. davinci_i2c_unprepare_recovery(adap);
  323. }
  324. static struct i2c_bus_recovery_info davinci_i2c_scl_recovery_info = {
  325. .recover_bus = i2c_generic_scl_recovery,
  326. .set_scl = davinci_i2c_set_scl,
  327. .get_scl = davinci_i2c_get_scl,
  328. .get_sda = davinci_i2c_get_sda,
  329. .prepare_recovery = davinci_i2c_scl_prepare_recovery,
  330. .unprepare_recovery = davinci_i2c_scl_unprepare_recovery,
  331. };
  332. /*
  333. * Waiting for bus not busy
  334. */
  335. static int i2c_davinci_wait_bus_not_busy(struct davinci_i2c_dev *dev)
  336. {
  337. unsigned long timeout = jiffies + dev->adapter.timeout;
  338. do {
  339. if (!(davinci_i2c_read_reg(dev, DAVINCI_I2C_STR_REG) & DAVINCI_I2C_STR_BB))
  340. return 0;
  341. schedule_timeout_uninterruptible(1);
  342. } while (time_before_eq(jiffies, timeout));
  343. dev_warn(dev->dev, "timeout waiting for bus ready\n");
  344. i2c_recover_bus(&dev->adapter);
  345. /*
  346. * if bus is still "busy" here, it's most probably a HW problem like
  347. * short-circuit
  348. */
  349. if (davinci_i2c_read_reg(dev, DAVINCI_I2C_STR_REG) & DAVINCI_I2C_STR_BB)
  350. return -EIO;
  351. return 0;
  352. }
  353. /*
  354. * Low level master read/write transaction. This function is called
  355. * from i2c_davinci_xfer.
  356. */
  357. static int
  358. i2c_davinci_xfer_msg(struct i2c_adapter *adap, struct i2c_msg *msg, int stop)
  359. {
  360. struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
  361. struct davinci_i2c_platform_data *pdata = dev->pdata;
  362. u32 flag;
  363. u16 w;
  364. unsigned long time_left;
  365. if (msg->addr == DAVINCI_I2C_OWN_ADDRESS) {
  366. dev_warn(dev->dev, "transfer to own address aborted\n");
  367. return -EADDRNOTAVAIL;
  368. }
  369. /* Introduce a delay, required for some boards (e.g Davinci EVM) */
  370. if (pdata->bus_delay)
  371. udelay(pdata->bus_delay);
  372. /* set the slave address */
  373. davinci_i2c_write_reg(dev, DAVINCI_I2C_SAR_REG, msg->addr);
  374. dev->buf = msg->buf;
  375. dev->buf_len = msg->len;
  376. dev->stop = stop;
  377. davinci_i2c_write_reg(dev, DAVINCI_I2C_CNT_REG, dev->buf_len);
  378. reinit_completion(&dev->cmd_complete);
  379. dev->cmd_err = 0;
  380. /* Take I2C out of reset and configure it as master */
  381. flag = DAVINCI_I2C_MDR_IRS | DAVINCI_I2C_MDR_MST;
  382. /* if the slave address is ten bit address, enable XA bit */
  383. if (msg->flags & I2C_M_TEN)
  384. flag |= DAVINCI_I2C_MDR_XA;
  385. if (!(msg->flags & I2C_M_RD))
  386. flag |= DAVINCI_I2C_MDR_TRX;
  387. if (msg->len == 0)
  388. flag |= DAVINCI_I2C_MDR_RM;
  389. /* Enable receive or transmit interrupts */
  390. w = davinci_i2c_read_reg(dev, DAVINCI_I2C_IMR_REG);
  391. if (msg->flags & I2C_M_RD)
  392. w |= DAVINCI_I2C_IMR_RRDY;
  393. else
  394. w |= DAVINCI_I2C_IMR_XRDY;
  395. davinci_i2c_write_reg(dev, DAVINCI_I2C_IMR_REG, w);
  396. dev->terminate = 0;
  397. /*
  398. * Write mode register first as needed for correct behaviour
  399. * on OMAP-L138, but don't set STT yet to avoid a race with XRDY
  400. * occurring before we have loaded DXR
  401. */
  402. davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, flag);
  403. /*
  404. * First byte should be set here, not after interrupt,
  405. * because transmit-data-ready interrupt can come before
  406. * NACK-interrupt during sending of previous message and
  407. * ICDXR may have wrong data
  408. * It also saves us one interrupt, slightly faster
  409. */
  410. if ((!(msg->flags & I2C_M_RD)) && dev->buf_len) {
  411. davinci_i2c_write_reg(dev, DAVINCI_I2C_DXR_REG, *dev->buf++);
  412. dev->buf_len--;
  413. }
  414. /* Set STT to begin transmit now DXR is loaded */
  415. flag |= DAVINCI_I2C_MDR_STT;
  416. if (stop && msg->len != 0)
  417. flag |= DAVINCI_I2C_MDR_STP;
  418. davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, flag);
  419. time_left = wait_for_completion_timeout(&dev->cmd_complete,
  420. dev->adapter.timeout);
  421. if (!time_left) {
  422. dev_err(dev->dev, "controller timed out\n");
  423. i2c_recover_bus(adap);
  424. dev->buf_len = 0;
  425. return -ETIMEDOUT;
  426. }
  427. if (dev->buf_len) {
  428. /* This should be 0 if all bytes were transferred
  429. * or dev->cmd_err denotes an error.
  430. */
  431. dev_err(dev->dev, "abnormal termination buf_len=%i\n",
  432. dev->buf_len);
  433. dev->terminate = 1;
  434. wmb();
  435. dev->buf_len = 0;
  436. return -EREMOTEIO;
  437. }
  438. /* no error */
  439. if (likely(!dev->cmd_err))
  440. return msg->len;
  441. /* We have an error */
  442. if (dev->cmd_err & DAVINCI_I2C_STR_AL) {
  443. i2c_davinci_init(dev);
  444. return -EIO;
  445. }
  446. if (dev->cmd_err & DAVINCI_I2C_STR_NACK) {
  447. if (msg->flags & I2C_M_IGNORE_NAK)
  448. return msg->len;
  449. w = davinci_i2c_read_reg(dev, DAVINCI_I2C_MDR_REG);
  450. w |= DAVINCI_I2C_MDR_STP;
  451. davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, w);
  452. return -EREMOTEIO;
  453. }
  454. return -EIO;
  455. }
  456. /*
  457. * Prepare controller for a transaction and call i2c_davinci_xfer_msg
  458. */
  459. static int
  460. i2c_davinci_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
  461. {
  462. struct davinci_i2c_dev *dev = i2c_get_adapdata(adap);
  463. int i;
  464. int ret;
  465. dev_dbg(dev->dev, "%s: msgs: %d\n", __func__, num);
  466. ret = pm_runtime_get_sync(dev->dev);
  467. if (ret < 0) {
  468. dev_err(dev->dev, "Failed to runtime_get device: %d\n", ret);
  469. pm_runtime_put_noidle(dev->dev);
  470. return ret;
  471. }
  472. ret = i2c_davinci_wait_bus_not_busy(dev);
  473. if (ret < 0) {
  474. dev_warn(dev->dev, "timeout waiting for bus ready\n");
  475. goto out;
  476. }
  477. for (i = 0; i < num; i++) {
  478. ret = i2c_davinci_xfer_msg(adap, &msgs[i], (i == (num - 1)));
  479. dev_dbg(dev->dev, "%s [%d/%d] ret: %d\n", __func__, i + 1, num,
  480. ret);
  481. if (ret < 0)
  482. goto out;
  483. }
  484. ret = num;
  485. #ifdef CONFIG_CPU_FREQ
  486. complete(&dev->xfr_complete);
  487. #endif
  488. out:
  489. pm_runtime_mark_last_busy(dev->dev);
  490. pm_runtime_put_autosuspend(dev->dev);
  491. return ret;
  492. }
  493. static u32 i2c_davinci_func(struct i2c_adapter *adap)
  494. {
  495. return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
  496. }
  497. static void terminate_read(struct davinci_i2c_dev *dev)
  498. {
  499. u16 w = davinci_i2c_read_reg(dev, DAVINCI_I2C_MDR_REG);
  500. w |= DAVINCI_I2C_MDR_NACK;
  501. davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, w);
  502. /* Throw away data */
  503. davinci_i2c_read_reg(dev, DAVINCI_I2C_DRR_REG);
  504. if (!dev->terminate)
  505. dev_err(dev->dev, "RDR IRQ while no data requested\n");
  506. }
  507. static void terminate_write(struct davinci_i2c_dev *dev)
  508. {
  509. u16 w = davinci_i2c_read_reg(dev, DAVINCI_I2C_MDR_REG);
  510. w |= DAVINCI_I2C_MDR_RM | DAVINCI_I2C_MDR_STP;
  511. davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, w);
  512. if (!dev->terminate)
  513. dev_dbg(dev->dev, "TDR IRQ while no data to send\n");
  514. }
  515. /*
  516. * Interrupt service routine. This gets called whenever an I2C interrupt
  517. * occurs.
  518. */
  519. static irqreturn_t i2c_davinci_isr(int this_irq, void *dev_id)
  520. {
  521. struct davinci_i2c_dev *dev = dev_id;
  522. u32 stat;
  523. int count = 0;
  524. u16 w;
  525. if (pm_runtime_suspended(dev->dev))
  526. return IRQ_NONE;
  527. while ((stat = davinci_i2c_read_reg(dev, DAVINCI_I2C_IVR_REG))) {
  528. dev_dbg(dev->dev, "%s: stat=0x%x\n", __func__, stat);
  529. if (count++ == 100) {
  530. dev_warn(dev->dev, "Too much work in one IRQ\n");
  531. break;
  532. }
  533. switch (stat) {
  534. case DAVINCI_I2C_IVR_AL:
  535. /* Arbitration lost, must retry */
  536. dev->cmd_err |= DAVINCI_I2C_STR_AL;
  537. dev->buf_len = 0;
  538. complete(&dev->cmd_complete);
  539. break;
  540. case DAVINCI_I2C_IVR_NACK:
  541. dev->cmd_err |= DAVINCI_I2C_STR_NACK;
  542. dev->buf_len = 0;
  543. complete(&dev->cmd_complete);
  544. break;
  545. case DAVINCI_I2C_IVR_ARDY:
  546. davinci_i2c_write_reg(dev,
  547. DAVINCI_I2C_STR_REG, DAVINCI_I2C_STR_ARDY);
  548. if (((dev->buf_len == 0) && (dev->stop != 0)) ||
  549. (dev->cmd_err & DAVINCI_I2C_STR_NACK)) {
  550. w = davinci_i2c_read_reg(dev,
  551. DAVINCI_I2C_MDR_REG);
  552. w |= DAVINCI_I2C_MDR_STP;
  553. davinci_i2c_write_reg(dev,
  554. DAVINCI_I2C_MDR_REG, w);
  555. }
  556. complete(&dev->cmd_complete);
  557. break;
  558. case DAVINCI_I2C_IVR_RDR:
  559. if (dev->buf_len) {
  560. *dev->buf++ =
  561. davinci_i2c_read_reg(dev,
  562. DAVINCI_I2C_DRR_REG);
  563. dev->buf_len--;
  564. if (dev->buf_len)
  565. continue;
  566. davinci_i2c_write_reg(dev,
  567. DAVINCI_I2C_STR_REG,
  568. DAVINCI_I2C_IMR_RRDY);
  569. } else {
  570. /* signal can terminate transfer */
  571. terminate_read(dev);
  572. }
  573. break;
  574. case DAVINCI_I2C_IVR_XRDY:
  575. if (dev->buf_len) {
  576. davinci_i2c_write_reg(dev, DAVINCI_I2C_DXR_REG,
  577. *dev->buf++);
  578. dev->buf_len--;
  579. if (dev->buf_len)
  580. continue;
  581. w = davinci_i2c_read_reg(dev,
  582. DAVINCI_I2C_IMR_REG);
  583. w &= ~DAVINCI_I2C_IMR_XRDY;
  584. davinci_i2c_write_reg(dev,
  585. DAVINCI_I2C_IMR_REG,
  586. w);
  587. } else {
  588. /* signal can terminate transfer */
  589. terminate_write(dev);
  590. }
  591. break;
  592. case DAVINCI_I2C_IVR_SCD:
  593. davinci_i2c_write_reg(dev,
  594. DAVINCI_I2C_STR_REG, DAVINCI_I2C_STR_SCD);
  595. complete(&dev->cmd_complete);
  596. break;
  597. case DAVINCI_I2C_IVR_AAS:
  598. dev_dbg(dev->dev, "Address as slave interrupt\n");
  599. break;
  600. default:
  601. dev_warn(dev->dev, "Unrecognized irq stat %d\n", stat);
  602. break;
  603. }
  604. }
  605. return count ? IRQ_HANDLED : IRQ_NONE;
  606. }
  607. #ifdef CONFIG_CPU_FREQ
  608. static int i2c_davinci_cpufreq_transition(struct notifier_block *nb,
  609. unsigned long val, void *data)
  610. {
  611. struct davinci_i2c_dev *dev;
  612. dev = container_of(nb, struct davinci_i2c_dev, freq_transition);
  613. if (val == CPUFREQ_PRECHANGE) {
  614. wait_for_completion(&dev->xfr_complete);
  615. davinci_i2c_reset_ctrl(dev, 0);
  616. } else if (val == CPUFREQ_POSTCHANGE) {
  617. i2c_davinci_calc_clk_dividers(dev);
  618. davinci_i2c_reset_ctrl(dev, 1);
  619. }
  620. return 0;
  621. }
  622. static inline int i2c_davinci_cpufreq_register(struct davinci_i2c_dev *dev)
  623. {
  624. dev->freq_transition.notifier_call = i2c_davinci_cpufreq_transition;
  625. return cpufreq_register_notifier(&dev->freq_transition,
  626. CPUFREQ_TRANSITION_NOTIFIER);
  627. }
  628. static inline void i2c_davinci_cpufreq_deregister(struct davinci_i2c_dev *dev)
  629. {
  630. cpufreq_unregister_notifier(&dev->freq_transition,
  631. CPUFREQ_TRANSITION_NOTIFIER);
  632. }
  633. #else
  634. static inline int i2c_davinci_cpufreq_register(struct davinci_i2c_dev *dev)
  635. {
  636. return 0;
  637. }
  638. static inline void i2c_davinci_cpufreq_deregister(struct davinci_i2c_dev *dev)
  639. {
  640. }
  641. #endif
  642. static struct i2c_algorithm i2c_davinci_algo = {
  643. .master_xfer = i2c_davinci_xfer,
  644. .functionality = i2c_davinci_func,
  645. };
  646. static const struct of_device_id davinci_i2c_of_match[] = {
  647. {.compatible = "ti,davinci-i2c", },
  648. {.compatible = "ti,keystone-i2c", },
  649. {},
  650. };
  651. MODULE_DEVICE_TABLE(of, davinci_i2c_of_match);
  652. static int davinci_i2c_probe(struct platform_device *pdev)
  653. {
  654. struct davinci_i2c_dev *dev;
  655. struct i2c_adapter *adap;
  656. struct resource *mem;
  657. int r, irq;
  658. irq = platform_get_irq(pdev, 0);
  659. if (irq <= 0) {
  660. if (!irq)
  661. irq = -ENXIO;
  662. if (irq != -EPROBE_DEFER)
  663. dev_err(&pdev->dev,
  664. "can't get irq resource ret=%d\n", irq);
  665. return irq;
  666. }
  667. dev = devm_kzalloc(&pdev->dev, sizeof(struct davinci_i2c_dev),
  668. GFP_KERNEL);
  669. if (!dev) {
  670. dev_err(&pdev->dev, "Memory allocation failed\n");
  671. return -ENOMEM;
  672. }
  673. init_completion(&dev->cmd_complete);
  674. #ifdef CONFIG_CPU_FREQ
  675. init_completion(&dev->xfr_complete);
  676. #endif
  677. dev->dev = &pdev->dev;
  678. dev->irq = irq;
  679. dev->pdata = dev_get_platdata(&pdev->dev);
  680. platform_set_drvdata(pdev, dev);
  681. if (!dev->pdata && pdev->dev.of_node) {
  682. u32 prop;
  683. dev->pdata = devm_kzalloc(&pdev->dev,
  684. sizeof(struct davinci_i2c_platform_data), GFP_KERNEL);
  685. if (!dev->pdata)
  686. return -ENOMEM;
  687. memcpy(dev->pdata, &davinci_i2c_platform_data_default,
  688. sizeof(struct davinci_i2c_platform_data));
  689. if (!of_property_read_u32(pdev->dev.of_node, "clock-frequency",
  690. &prop))
  691. dev->pdata->bus_freq = prop / 1000;
  692. dev->pdata->has_pfunc =
  693. of_property_read_bool(pdev->dev.of_node,
  694. "ti,has-pfunc");
  695. } else if (!dev->pdata) {
  696. dev->pdata = &davinci_i2c_platform_data_default;
  697. }
  698. dev->clk = devm_clk_get(&pdev->dev, NULL);
  699. if (IS_ERR(dev->clk))
  700. return PTR_ERR(dev->clk);
  701. mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  702. dev->base = devm_ioremap_resource(&pdev->dev, mem);
  703. if (IS_ERR(dev->base)) {
  704. r = PTR_ERR(dev->base);
  705. goto err_unuse_clocks;
  706. }
  707. pm_runtime_enable(dev->dev);
  708. pm_runtime_set_autosuspend_delay(dev->dev,
  709. DAVINCI_I2C_PM_TIMEOUT);
  710. pm_runtime_use_autosuspend(dev->dev);
  711. r = pm_runtime_get_sync(dev->dev);
  712. if (r < 0) {
  713. dev_err(dev->dev, "failed to runtime_get device: %d\n", r);
  714. goto err_unuse_clocks;
  715. }
  716. i2c_davinci_init(dev);
  717. r = devm_request_irq(&pdev->dev, dev->irq, i2c_davinci_isr, 0,
  718. pdev->name, dev);
  719. if (r) {
  720. dev_err(&pdev->dev, "failure requesting irq %i\n", dev->irq);
  721. goto err_unuse_clocks;
  722. }
  723. r = i2c_davinci_cpufreq_register(dev);
  724. if (r) {
  725. dev_err(&pdev->dev, "failed to register cpufreq\n");
  726. goto err_unuse_clocks;
  727. }
  728. adap = &dev->adapter;
  729. i2c_set_adapdata(adap, dev);
  730. adap->owner = THIS_MODULE;
  731. adap->class = I2C_CLASS_DEPRECATED;
  732. strlcpy(adap->name, "DaVinci I2C adapter", sizeof(adap->name));
  733. adap->algo = &i2c_davinci_algo;
  734. adap->dev.parent = &pdev->dev;
  735. adap->timeout = DAVINCI_I2C_TIMEOUT;
  736. adap->dev.of_node = pdev->dev.of_node;
  737. if (dev->pdata->has_pfunc)
  738. adap->bus_recovery_info = &davinci_i2c_scl_recovery_info;
  739. else if (dev->pdata->scl_pin) {
  740. adap->bus_recovery_info = &davinci_i2c_gpio_recovery_info;
  741. adap->bus_recovery_info->scl_gpio = dev->pdata->scl_pin;
  742. adap->bus_recovery_info->sda_gpio = dev->pdata->sda_pin;
  743. }
  744. adap->nr = pdev->id;
  745. r = i2c_add_numbered_adapter(adap);
  746. if (r)
  747. goto err_unuse_clocks;
  748. pm_runtime_mark_last_busy(dev->dev);
  749. pm_runtime_put_autosuspend(dev->dev);
  750. return 0;
  751. err_unuse_clocks:
  752. pm_runtime_dont_use_autosuspend(dev->dev);
  753. pm_runtime_put_sync(dev->dev);
  754. pm_runtime_disable(dev->dev);
  755. dev->clk = NULL;
  756. return r;
  757. }
  758. static int davinci_i2c_remove(struct platform_device *pdev)
  759. {
  760. struct davinci_i2c_dev *dev = platform_get_drvdata(pdev);
  761. int ret;
  762. i2c_davinci_cpufreq_deregister(dev);
  763. i2c_del_adapter(&dev->adapter);
  764. ret = pm_runtime_get_sync(&pdev->dev);
  765. if (ret < 0) {
  766. pm_runtime_put_noidle(&pdev->dev);
  767. return ret;
  768. }
  769. dev->clk = NULL;
  770. davinci_i2c_write_reg(dev, DAVINCI_I2C_MDR_REG, 0);
  771. pm_runtime_dont_use_autosuspend(dev->dev);
  772. pm_runtime_put_sync(dev->dev);
  773. pm_runtime_disable(dev->dev);
  774. return 0;
  775. }
  776. #ifdef CONFIG_PM
  777. static int davinci_i2c_suspend(struct device *dev)
  778. {
  779. struct platform_device *pdev = to_platform_device(dev);
  780. struct davinci_i2c_dev *i2c_dev = platform_get_drvdata(pdev);
  781. /* put I2C into reset */
  782. davinci_i2c_reset_ctrl(i2c_dev, 0);
  783. return 0;
  784. }
  785. static int davinci_i2c_resume(struct device *dev)
  786. {
  787. struct platform_device *pdev = to_platform_device(dev);
  788. struct davinci_i2c_dev *i2c_dev = platform_get_drvdata(pdev);
  789. /* take I2C out of reset */
  790. davinci_i2c_reset_ctrl(i2c_dev, 1);
  791. return 0;
  792. }
  793. static const struct dev_pm_ops davinci_i2c_pm = {
  794. .suspend = davinci_i2c_suspend,
  795. .resume = davinci_i2c_resume,
  796. SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
  797. pm_runtime_force_resume)
  798. };
  799. #define davinci_i2c_pm_ops (&davinci_i2c_pm)
  800. #else
  801. #define davinci_i2c_pm_ops NULL
  802. #endif
  803. /* work with hotplug and coldplug */
  804. MODULE_ALIAS("platform:i2c_davinci");
  805. static struct platform_driver davinci_i2c_driver = {
  806. .probe = davinci_i2c_probe,
  807. .remove = davinci_i2c_remove,
  808. .driver = {
  809. .name = "i2c_davinci",
  810. .pm = davinci_i2c_pm_ops,
  811. .of_match_table = davinci_i2c_of_match,
  812. },
  813. };
  814. /* I2C may be needed to bring up other drivers */
  815. static int __init davinci_i2c_init_driver(void)
  816. {
  817. return platform_driver_register(&davinci_i2c_driver);
  818. }
  819. subsys_initcall(davinci_i2c_init_driver);
  820. static void __exit davinci_i2c_exit_driver(void)
  821. {
  822. platform_driver_unregister(&davinci_i2c_driver);
  823. }
  824. module_exit(davinci_i2c_exit_driver);
  825. MODULE_AUTHOR("Texas Instruments India");
  826. MODULE_DESCRIPTION("TI DaVinci I2C bus adapter");
  827. MODULE_LICENSE("GPL");