c_can_platform.c 8.1 KB

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