c_can_platform.c 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347
  1. /*
  2. * Platform CAN bus driver for Bosch C_CAN controller
  3. *
  4. * Copyright (C) 2010 ST Microelectronics
  5. * Bhupesh Sharma <bhupesh.sharma@st.com>
  6. *
  7. * Borrowed heavily from the C_CAN driver originally written by:
  8. * Copyright (C) 2007
  9. * - Sascha Hauer, Marc Kleine-Budde, Pengutronix <s.hauer@pengutronix.de>
  10. * - Simon Kallweit, intefo AG <simon.kallweit@intefo.ch>
  11. *
  12. * Bosch C_CAN controller is compliant to CAN protocol version 2.0 part A and B.
  13. * Bosch C_CAN user manual can be obtained from:
  14. * http://www.semiconductors.bosch.de/media/en/pdf/ipmodules_1/c_can/
  15. * users_manual_c_can.pdf
  16. *
  17. * This file is licensed under the terms of the GNU General Public
  18. * License version 2. This program is licensed "as is" without any
  19. * warranty of any kind, whether express or implied.
  20. */
  21. #include <linux/kernel.h>
  22. #include <linux/module.h>
  23. #include <linux/interrupt.h>
  24. #include <linux/delay.h>
  25. #include <linux/netdevice.h>
  26. #include <linux/if_arp.h>
  27. #include <linux/if_ether.h>
  28. #include <linux/list.h>
  29. #include <linux/io.h>
  30. #include <linux/platform_device.h>
  31. #include <linux/clk.h>
  32. #include <linux/of.h>
  33. #include <linux/of_device.h>
  34. #include <linux/pinctrl/consumer.h>
  35. #include <linux/can/dev.h>
  36. #include "c_can.h"
  37. #define CAN_RAMINIT_START_MASK(i) (1 << (i))
  38. /*
  39. * 16-bit c_can registers can be arranged differently in the memory
  40. * architecture of different implementations. For example: 16-bit
  41. * registers can be aligned to a 16-bit boundary or 32-bit boundary etc.
  42. * Handle the same by providing a common read/write interface.
  43. */
  44. static u16 c_can_plat_read_reg_aligned_to_16bit(struct c_can_priv *priv,
  45. enum reg index)
  46. {
  47. return readw(priv->base + priv->regs[index]);
  48. }
  49. static void c_can_plat_write_reg_aligned_to_16bit(struct c_can_priv *priv,
  50. enum reg index, u16 val)
  51. {
  52. writew(val, priv->base + priv->regs[index]);
  53. }
  54. static u16 c_can_plat_read_reg_aligned_to_32bit(struct c_can_priv *priv,
  55. enum reg index)
  56. {
  57. return readw(priv->base + 2 * priv->regs[index]);
  58. }
  59. static void c_can_plat_write_reg_aligned_to_32bit(struct c_can_priv *priv,
  60. enum reg index, u16 val)
  61. {
  62. writew(val, priv->base + 2 * priv->regs[index]);
  63. }
  64. static void c_can_hw_raminit(const struct c_can_priv *priv, bool enable)
  65. {
  66. u32 val;
  67. val = readl(priv->raminit_ctrlreg);
  68. if (enable)
  69. val |= CAN_RAMINIT_START_MASK(priv->instance);
  70. else
  71. val &= ~CAN_RAMINIT_START_MASK(priv->instance);
  72. writel(val, priv->raminit_ctrlreg);
  73. }
  74. static struct platform_device_id c_can_id_table[] = {
  75. [BOSCH_C_CAN_PLATFORM] = {
  76. .name = KBUILD_MODNAME,
  77. .driver_data = BOSCH_C_CAN,
  78. },
  79. [BOSCH_C_CAN] = {
  80. .name = "c_can",
  81. .driver_data = BOSCH_C_CAN,
  82. },
  83. [BOSCH_D_CAN] = {
  84. .name = "d_can",
  85. .driver_data = BOSCH_D_CAN,
  86. }, {
  87. }
  88. };
  89. MODULE_DEVICE_TABLE(platform, c_can_id_table);
  90. static const struct of_device_id c_can_of_table[] = {
  91. { .compatible = "bosch,c_can", .data = &c_can_id_table[BOSCH_C_CAN] },
  92. { .compatible = "bosch,d_can", .data = &c_can_id_table[BOSCH_D_CAN] },
  93. { /* sentinel */ },
  94. };
  95. MODULE_DEVICE_TABLE(of, c_can_of_table);
  96. static int c_can_plat_probe(struct platform_device *pdev)
  97. {
  98. int ret;
  99. void __iomem *addr;
  100. struct net_device *dev;
  101. struct c_can_priv *priv;
  102. const struct of_device_id *match;
  103. const struct platform_device_id *id;
  104. struct pinctrl *pinctrl;
  105. struct resource *mem, *res;
  106. int irq;
  107. struct clk *clk;
  108. if (pdev->dev.of_node) {
  109. match = of_match_device(c_can_of_table, &pdev->dev);
  110. if (!match) {
  111. dev_err(&pdev->dev, "Failed to find matching dt id\n");
  112. ret = -EINVAL;
  113. goto exit;
  114. }
  115. id = match->data;
  116. } else {
  117. id = platform_get_device_id(pdev);
  118. }
  119. pinctrl = devm_pinctrl_get_select_default(&pdev->dev);
  120. if (IS_ERR(pinctrl))
  121. dev_warn(&pdev->dev,
  122. "failed to configure pins from driver\n");
  123. /* get the appropriate clk */
  124. clk = clk_get(&pdev->dev, NULL);
  125. if (IS_ERR(clk)) {
  126. dev_err(&pdev->dev, "no clock defined\n");
  127. ret = -ENODEV;
  128. goto exit;
  129. }
  130. /* get the platform data */
  131. mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  132. irq = platform_get_irq(pdev, 0);
  133. if (!mem || irq <= 0) {
  134. ret = -ENODEV;
  135. goto exit_free_clk;
  136. }
  137. if (!request_mem_region(mem->start, resource_size(mem),
  138. KBUILD_MODNAME)) {
  139. dev_err(&pdev->dev, "resource unavailable\n");
  140. ret = -ENODEV;
  141. goto exit_free_clk;
  142. }
  143. addr = ioremap(mem->start, resource_size(mem));
  144. if (!addr) {
  145. dev_err(&pdev->dev, "failed to map can port\n");
  146. ret = -ENOMEM;
  147. goto exit_release_mem;
  148. }
  149. /* allocate the c_can device */
  150. dev = alloc_c_can_dev();
  151. if (!dev) {
  152. ret = -ENOMEM;
  153. goto exit_iounmap;
  154. }
  155. priv = netdev_priv(dev);
  156. switch (id->driver_data) {
  157. case BOSCH_C_CAN:
  158. priv->regs = reg_map_c_can;
  159. switch (mem->flags & IORESOURCE_MEM_TYPE_MASK) {
  160. case IORESOURCE_MEM_32BIT:
  161. priv->read_reg = c_can_plat_read_reg_aligned_to_32bit;
  162. priv->write_reg = c_can_plat_write_reg_aligned_to_32bit;
  163. break;
  164. case IORESOURCE_MEM_16BIT:
  165. default:
  166. priv->read_reg = c_can_plat_read_reg_aligned_to_16bit;
  167. priv->write_reg = c_can_plat_write_reg_aligned_to_16bit;
  168. break;
  169. }
  170. break;
  171. case BOSCH_D_CAN:
  172. priv->regs = reg_map_d_can;
  173. priv->can.ctrlmode_supported |= CAN_CTRLMODE_3_SAMPLES;
  174. priv->read_reg = c_can_plat_read_reg_aligned_to_16bit;
  175. priv->write_reg = c_can_plat_write_reg_aligned_to_16bit;
  176. if (pdev->dev.of_node)
  177. priv->instance = of_alias_get_id(pdev->dev.of_node, "d_can");
  178. else
  179. priv->instance = pdev->id;
  180. res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
  181. priv->raminit_ctrlreg = devm_request_and_ioremap(&pdev->dev, res);
  182. if (!priv->raminit_ctrlreg || priv->instance < 0)
  183. dev_info(&pdev->dev, "control memory is not used for raminit\n");
  184. else
  185. priv->raminit = c_can_hw_raminit;
  186. break;
  187. default:
  188. ret = -EINVAL;
  189. goto exit_free_device;
  190. }
  191. dev->irq = irq;
  192. priv->base = addr;
  193. priv->device = &pdev->dev;
  194. priv->can.clock.freq = clk_get_rate(clk);
  195. priv->priv = clk;
  196. priv->type = id->driver_data;
  197. platform_set_drvdata(pdev, dev);
  198. SET_NETDEV_DEV(dev, &pdev->dev);
  199. ret = register_c_can_dev(dev);
  200. if (ret) {
  201. dev_err(&pdev->dev, "registering %s failed (err=%d)\n",
  202. KBUILD_MODNAME, ret);
  203. goto exit_free_device;
  204. }
  205. dev_info(&pdev->dev, "%s device registered (regs=%p, irq=%d)\n",
  206. KBUILD_MODNAME, priv->base, dev->irq);
  207. return 0;
  208. exit_free_device:
  209. platform_set_drvdata(pdev, NULL);
  210. free_c_can_dev(dev);
  211. exit_iounmap:
  212. iounmap(addr);
  213. exit_release_mem:
  214. release_mem_region(mem->start, resource_size(mem));
  215. exit_free_clk:
  216. clk_put(clk);
  217. exit:
  218. dev_err(&pdev->dev, "probe failed\n");
  219. return ret;
  220. }
  221. static int c_can_plat_remove(struct platform_device *pdev)
  222. {
  223. struct net_device *dev = platform_get_drvdata(pdev);
  224. struct c_can_priv *priv = netdev_priv(dev);
  225. struct resource *mem;
  226. unregister_c_can_dev(dev);
  227. platform_set_drvdata(pdev, NULL);
  228. free_c_can_dev(dev);
  229. iounmap(priv->base);
  230. mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  231. release_mem_region(mem->start, resource_size(mem));
  232. clk_put(priv->priv);
  233. return 0;
  234. }
  235. #ifdef CONFIG_PM
  236. static int c_can_suspend(struct platform_device *pdev, pm_message_t state)
  237. {
  238. int ret;
  239. struct net_device *ndev = platform_get_drvdata(pdev);
  240. struct c_can_priv *priv = netdev_priv(ndev);
  241. if (priv->type != BOSCH_D_CAN) {
  242. dev_warn(&pdev->dev, "Not supported\n");
  243. return 0;
  244. }
  245. if (netif_running(ndev)) {
  246. netif_stop_queue(ndev);
  247. netif_device_detach(ndev);
  248. }
  249. ret = c_can_power_down(ndev);
  250. if (ret) {
  251. netdev_err(ndev, "failed to enter power down mode\n");
  252. return ret;
  253. }
  254. priv->can.state = CAN_STATE_SLEEPING;
  255. return 0;
  256. }
  257. static int c_can_resume(struct platform_device *pdev)
  258. {
  259. int ret;
  260. struct net_device *ndev = platform_get_drvdata(pdev);
  261. struct c_can_priv *priv = netdev_priv(ndev);
  262. if (priv->type != BOSCH_D_CAN) {
  263. dev_warn(&pdev->dev, "Not supported\n");
  264. return 0;
  265. }
  266. ret = c_can_power_up(ndev);
  267. if (ret) {
  268. netdev_err(ndev, "Still in power down mode\n");
  269. return ret;
  270. }
  271. priv->can.state = CAN_STATE_ERROR_ACTIVE;
  272. if (netif_running(ndev)) {
  273. netif_device_attach(ndev);
  274. netif_start_queue(ndev);
  275. }
  276. return 0;
  277. }
  278. #else
  279. #define c_can_suspend NULL
  280. #define c_can_resume NULL
  281. #endif
  282. static struct platform_driver c_can_plat_driver = {
  283. .driver = {
  284. .name = KBUILD_MODNAME,
  285. .owner = THIS_MODULE,
  286. .of_match_table = of_match_ptr(c_can_of_table),
  287. },
  288. .probe = c_can_plat_probe,
  289. .remove = c_can_plat_remove,
  290. .suspend = c_can_suspend,
  291. .resume = c_can_resume,
  292. .id_table = c_can_id_table,
  293. };
  294. module_platform_driver(c_can_plat_driver);
  295. MODULE_AUTHOR("Bhupesh Sharma <bhupesh.sharma@st.com>");
  296. MODULE_LICENSE("GPL v2");
  297. MODULE_DESCRIPTION("Platform CAN bus driver for Bosch C_CAN controller");