]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - drivers/net/can/c_can/c_can_platform.c
Merge git://git.kernel.org/pub/scm/linux/kernel/git/netdev/net
[mirror_ubuntu-jammy-kernel.git] / drivers / net / can / c_can / c_can_platform.c
CommitLineData
881ff67a
BS
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
22#include <linux/kernel.h>
881ff67a
BS
23#include <linux/module.h>
24#include <linux/interrupt.h>
25#include <linux/delay.h>
26#include <linux/netdevice.h>
27#include <linux/if_arp.h>
28#include <linux/if_ether.h>
29#include <linux/list.h>
881ff67a
BS
30#include <linux/io.h>
31#include <linux/platform_device.h>
32#include <linux/clk.h>
2469627d
AC
33#include <linux/of.h>
34#include <linux/of_device.h>
3ff9027c
RQ
35#include <linux/mfd/syscon.h>
36#include <linux/regmap.h>
881ff67a
BS
37
38#include <linux/can/dev.h>
39
40#include "c_can.h"
41
e577ba72
MKB
42#define DCAN_RAM_INIT_BIT BIT(3)
43
5bb9cbaa 44static DEFINE_SPINLOCK(raminit_lock);
e577ba72
MKB
45
46/* 16-bit c_can registers can be arranged differently in the memory
881ff67a
BS
47 * architecture of different implementations. For example: 16-bit
48 * registers can be aligned to a 16-bit boundary or 32-bit boundary etc.
49 * Handle the same by providing a common read/write interface.
50 */
e07e83ae 51static u16 c_can_plat_read_reg_aligned_to_16bit(const struct c_can_priv *priv,
33f81009 52 enum reg index)
881ff67a 53{
33f81009 54 return readw(priv->base + priv->regs[index]);
881ff67a
BS
55}
56
e07e83ae 57static void c_can_plat_write_reg_aligned_to_16bit(const struct c_can_priv *priv,
e577ba72 58 enum reg index, u16 val)
881ff67a 59{
33f81009 60 writew(val, priv->base + priv->regs[index]);
881ff67a
BS
61}
62
e07e83ae 63static u16 c_can_plat_read_reg_aligned_to_32bit(const struct c_can_priv *priv,
33f81009 64 enum reg index)
881ff67a 65{
33f81009 66 return readw(priv->base + 2 * priv->regs[index]);
881ff67a
BS
67}
68
e07e83ae 69static void c_can_plat_write_reg_aligned_to_32bit(const struct c_can_priv *priv,
e577ba72 70 enum reg index, u16 val)
881ff67a 71{
33f81009 72 writew(val, priv->base + 2 * priv->regs[index]);
881ff67a
BS
73}
74
3ff9027c
RQ
75static void c_can_hw_raminit_wait_syscon(const struct c_can_priv *priv,
76 u32 mask, u32 val)
5bb9cbaa 77{
3ff9027c 78 const struct c_can_raminit *raminit = &priv->raminit_sys;
e7e26bc7 79 int timeout = 0;
3ff9027c 80 u32 ctrl = 0;
e7e26bc7 81
5bb9cbaa
TG
82 /* We look only at the bits of our instance. */
83 val &= mask;
3ff9027c 84 do {
5bb9cbaa 85 udelay(1);
e7e26bc7
RQ
86 timeout++;
87
3ff9027c 88 regmap_read(raminit->syscon, raminit->reg, &ctrl);
e7e26bc7
RQ
89 if (timeout == 1000) {
90 dev_err(&priv->dev->dev, "%s: time out\n", __func__);
91 break;
92 }
3ff9027c 93 } while ((ctrl & mask) != val);
5bb9cbaa
TG
94}
95
3ff9027c 96static void c_can_hw_raminit_syscon(const struct c_can_priv *priv, bool enable)
52cde85a 97{
3ff9027c
RQ
98 const struct c_can_raminit *raminit = &priv->raminit_sys;
99 u32 ctrl = 0;
100 u32 mask;
52cde85a 101
5bb9cbaa
TG
102 spin_lock(&raminit_lock);
103
3ff9027c
RQ
104 mask = 1 << raminit->bits.start | 1 << raminit->bits.done;
105 regmap_read(raminit->syscon, raminit->reg, &ctrl);
106
47e3485a 107 /* We clear the start bit first. The start bit is
5bb9cbaa 108 * looking at the 0 -> transition, but is not self clearing;
3ff9027c 109 * NOTE: DONE must be written with 1 to clear it.
47e3485a
RQ
110 * We can't clear the DONE bit here using regmap_update_bits()
111 * as it will bypass the write if initial condition is START:0 DONE:1
112 * e.g. on DRA7 which needs START pulse.
5bb9cbaa 113 */
47e3485a
RQ
114 ctrl &= ~mask; /* START = 0, DONE = 0 */
115 regmap_update_bits(raminit->syscon, raminit->reg, mask, ctrl);
3ff9027c 116
47e3485a
RQ
117 /* check if START bit is 0. Ignore DONE bit for now
118 * as it can be either 0 or 1.
119 */
120 c_can_hw_raminit_wait_syscon(priv, 1 << raminit->bits.start, ctrl);
5bb9cbaa
TG
121
122 if (enable) {
47e3485a 123 /* Clear DONE bit & set START bit. */
3ff9027c 124 ctrl |= 1 << raminit->bits.start;
47e3485a
RQ
125 /* DONE must be written with 1 to clear it */
126 ctrl |= 1 << raminit->bits.done;
127 regmap_update_bits(raminit->syscon, raminit->reg, mask, ctrl);
128 /* prevent further clearing of DONE bit */
129 ctrl &= ~(1 << raminit->bits.done);
0741bfb9
RQ
130 /* clear START bit if start pulse is needed */
131 if (raminit->needs_pulse) {
132 ctrl &= ~(1 << raminit->bits.start);
47e3485a
RQ
133 regmap_update_bits(raminit->syscon, raminit->reg,
134 mask, ctrl);
0741bfb9
RQ
135 }
136
3ff9027c
RQ
137 ctrl |= 1 << raminit->bits.done;
138 c_can_hw_raminit_wait_syscon(priv, mask, ctrl);
5bb9cbaa
TG
139 }
140 spin_unlock(&raminit_lock);
52cde85a
AC
141}
142
ccbc5357
PM
143static u32 c_can_plat_read_reg32(const struct c_can_priv *priv, enum reg index)
144{
145 u32 val;
146
147 val = priv->read_reg(priv, index);
e577ba72 148 val |= ((u32)priv->read_reg(priv, index + 1)) << 16;
ccbc5357
PM
149
150 return val;
151}
152
e577ba72
MKB
153static void c_can_plat_write_reg32(const struct c_can_priv *priv,
154 enum reg index, u32 val)
ccbc5357
PM
155{
156 priv->write_reg(priv, index + 1, val >> 16);
157 priv->write_reg(priv, index, val);
158}
159
160static u32 d_can_plat_read_reg32(const struct c_can_priv *priv, enum reg index)
161{
162 return readl(priv->base + priv->regs[index]);
163}
164
e577ba72
MKB
165static void d_can_plat_write_reg32(const struct c_can_priv *priv,
166 enum reg index, u32 val)
ccbc5357
PM
167{
168 writel(val, priv->base + priv->regs[index]);
169}
170
a9c69209
PM
171static void c_can_hw_raminit_wait(const struct c_can_priv *priv, u32 mask)
172{
173 while (priv->read_reg32(priv, C_CAN_FUNCTION_REG) & mask)
174 udelay(1);
175}
176
177static void c_can_hw_raminit(const struct c_can_priv *priv, bool enable)
178{
179 u32 ctrl;
180
181 ctrl = priv->read_reg32(priv, C_CAN_FUNCTION_REG);
182 ctrl &= ~DCAN_RAM_INIT_BIT;
183 priv->write_reg32(priv, C_CAN_FUNCTION_REG, ctrl);
184 c_can_hw_raminit_wait(priv, ctrl);
185
186 if (enable) {
187 ctrl |= DCAN_RAM_INIT_BIT;
188 priv->write_reg32(priv, C_CAN_FUNCTION_REG, ctrl);
189 c_can_hw_raminit_wait(priv, ctrl);
190 }
191}
192
15151090
RQ
193static const struct c_can_driver_data c_can_drvdata = {
194 .id = BOSCH_C_CAN,
195};
196
197static const struct c_can_driver_data d_can_drvdata = {
198 .id = BOSCH_D_CAN,
199};
200
0f4da3a8
RQ
201static const struct raminit_bits dra7_raminit_bits[] = {
202 [0] = { .start = 3, .done = 1, },
203 [1] = { .start = 5, .done = 2, },
204};
205
206static const struct c_can_driver_data dra7_dcan_drvdata = {
207 .id = BOSCH_D_CAN,
208 .raminit_num = ARRAY_SIZE(dra7_raminit_bits),
209 .raminit_bits = dra7_raminit_bits,
210 .raminit_pulse = true,
211};
212
c71d0b31
RQ
213static const struct raminit_bits am3352_raminit_bits[] = {
214 [0] = { .start = 0, .done = 8, },
215 [1] = { .start = 1, .done = 9, },
216};
217
218static const struct c_can_driver_data am3352_dcan_drvdata = {
219 .id = BOSCH_D_CAN,
220 .raminit_num = ARRAY_SIZE(am3352_raminit_bits),
221 .raminit_bits = am3352_raminit_bits,
222};
223
7496bece 224static const struct platform_device_id c_can_id_table[] = {
15151090 225 {
2469627d 226 .name = KBUILD_MODNAME,
15151090 227 .driver_data = (kernel_ulong_t)&c_can_drvdata,
2469627d 228 },
15151090 229 {
2469627d 230 .name = "c_can",
15151090 231 .driver_data = (kernel_ulong_t)&c_can_drvdata,
2469627d 232 },
15151090 233 {
2469627d 234 .name = "d_can",
15151090
RQ
235 .driver_data = (kernel_ulong_t)&d_can_drvdata,
236 },
237 { /* sentinel */ },
2469627d 238};
69c0c5b1 239MODULE_DEVICE_TABLE(platform, c_can_id_table);
2469627d
AC
240
241static const struct of_device_id c_can_of_table[] = {
15151090
RQ
242 { .compatible = "bosch,c_can", .data = &c_can_drvdata },
243 { .compatible = "bosch,d_can", .data = &d_can_drvdata },
0f4da3a8 244 { .compatible = "ti,dra7-d_can", .data = &dra7_dcan_drvdata },
c71d0b31 245 { .compatible = "ti,am3352-d_can", .data = &am3352_dcan_drvdata },
f2bf2589 246 { .compatible = "ti,am4372-d_can", .data = &am3352_dcan_drvdata },
2469627d
AC
247 { /* sentinel */ },
248};
69c0c5b1 249MODULE_DEVICE_TABLE(of, c_can_of_table);
2469627d 250
3c8ac0f2 251static int c_can_plat_probe(struct platform_device *pdev)
881ff67a
BS
252{
253 int ret;
254 void __iomem *addr;
255 struct net_device *dev;
256 struct c_can_priv *priv;
2469627d 257 const struct of_device_id *match;
3ff9027c 258 struct resource *mem;
b0052b08 259 int irq;
881ff67a 260 struct clk *clk;
15151090 261 const struct c_can_driver_data *drvdata;
3ff9027c 262 struct device_node *np = pdev->dev.of_node;
15151090
RQ
263
264 match = of_match_device(c_can_of_table, &pdev->dev);
265 if (match) {
266 drvdata = match->data;
267 } else if (pdev->id_entry->driver_data) {
268 drvdata = (struct c_can_driver_data *)
269 platform_get_device_id(pdev)->driver_data;
2469627d 270 } else {
15151090 271 return -ENODEV;
2469627d
AC
272 }
273
881ff67a 274 /* get the appropriate clk */
c6bf7e5f 275 clk = devm_clk_get(&pdev->dev, NULL);
881ff67a 276 if (IS_ERR(clk)) {
c6bf7e5f 277 ret = PTR_ERR(clk);
881ff67a
BS
278 goto exit;
279 }
881ff67a
BS
280
281 /* get the platform data */
b0052b08 282 irq = platform_get_irq(pdev, 0);
c6bf7e5f 283 if (irq <= 0) {
881ff67a 284 ret = -ENODEV;
c6bf7e5f 285 goto exit;
881ff67a
BS
286 }
287
c6bf7e5f
LP
288 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
289 addr = devm_ioremap_resource(&pdev->dev, mem);
290 if (IS_ERR(addr)) {
291 ret = PTR_ERR(addr);
292 goto exit;
881ff67a
BS
293 }
294
295 /* allocate the c_can device */
296 dev = alloc_c_can_dev();
297 if (!dev) {
298 ret = -ENOMEM;
c6bf7e5f 299 goto exit;
881ff67a
BS
300 }
301
302 priv = netdev_priv(dev);
15151090 303 switch (drvdata->id) {
f27b1db9 304 case BOSCH_C_CAN:
69927fcc
AC
305 priv->regs = reg_map_c_can;
306 switch (mem->flags & IORESOURCE_MEM_TYPE_MASK) {
307 case IORESOURCE_MEM_32BIT:
308 priv->read_reg = c_can_plat_read_reg_aligned_to_32bit;
309 priv->write_reg = c_can_plat_write_reg_aligned_to_32bit;
ccbc5357
PM
310 priv->read_reg32 = c_can_plat_read_reg32;
311 priv->write_reg32 = c_can_plat_write_reg32;
69927fcc
AC
312 break;
313 case IORESOURCE_MEM_16BIT:
314 default:
315 priv->read_reg = c_can_plat_read_reg_aligned_to_16bit;
316 priv->write_reg = c_can_plat_write_reg_aligned_to_16bit;
ccbc5357
PM
317 priv->read_reg32 = c_can_plat_read_reg32;
318 priv->write_reg32 = c_can_plat_write_reg32;
69927fcc
AC
319 break;
320 }
321 break;
f27b1db9 322 case BOSCH_D_CAN:
69927fcc 323 priv->regs = reg_map_d_can;
69927fcc
AC
324 priv->read_reg = c_can_plat_read_reg_aligned_to_16bit;
325 priv->write_reg = c_can_plat_write_reg_aligned_to_16bit;
ccbc5357
PM
326 priv->read_reg32 = d_can_plat_read_reg32;
327 priv->write_reg32 = d_can_plat_write_reg32;
52cde85a 328
3ff9027c
RQ
329 /* Check if we need custom RAMINIT via syscon. Mostly for TI
330 * platforms. Only supported with DT boot.
a9c69209 331 */
3ff9027c
RQ
332 if (np && of_property_read_bool(np, "syscon-raminit")) {
333 u32 id;
334 struct c_can_raminit *raminit = &priv->raminit_sys;
335
336 ret = -EINVAL;
337 raminit->syscon = syscon_regmap_lookup_by_phandle(np,
338 "syscon-raminit");
339 if (IS_ERR(raminit->syscon)) {
340 /* can fail with -EPROBE_DEFER */
341 ret = PTR_ERR(raminit->syscon);
342 free_c_can_dev(dev);
343 return ret;
344 }
345
346 if (of_property_read_u32_index(np, "syscon-raminit", 1,
347 &raminit->reg)) {
348 dev_err(&pdev->dev,
349 "couldn't get the RAMINIT reg. offset!\n");
350 goto exit_free_device;
351 }
352
353 if (of_property_read_u32_index(np, "syscon-raminit", 2,
354 &id)) {
355 dev_err(&pdev->dev,
356 "couldn't get the CAN instance ID\n");
357 goto exit_free_device;
358 }
359
360 if (id >= drvdata->raminit_num) {
361 dev_err(&pdev->dev,
362 "Invalid CAN instance ID\n");
363 goto exit_free_device;
364 }
365
366 raminit->bits = drvdata->raminit_bits[id];
0741bfb9 367 raminit->needs_pulse = drvdata->raminit_pulse;
3ff9027c
RQ
368
369 priv->raminit = c_can_hw_raminit_syscon;
370 } else {
a9c69209 371 priv->raminit = c_can_hw_raminit;
a9c69209 372 }
69927fcc
AC
373 break;
374 default:
375 ret = -EINVAL;
376 goto exit_free_device;
377 }
881ff67a 378
b0052b08 379 dev->irq = irq;
33f81009 380 priv->base = addr;
4cdd34b2 381 priv->device = &pdev->dev;
881ff67a
BS
382 priv->can.clock.freq = clk_get_rate(clk);
383 priv->priv = clk;
15151090 384 priv->type = drvdata->id;
881ff67a 385
881ff67a
BS
386 platform_set_drvdata(pdev, dev);
387 SET_NETDEV_DEV(dev, &pdev->dev);
388
389 ret = register_c_can_dev(dev);
390 if (ret) {
391 dev_err(&pdev->dev, "registering %s failed (err=%d)\n",
392 KBUILD_MODNAME, ret);
393 goto exit_free_device;
394 }
395
396 dev_info(&pdev->dev, "%s device registered (regs=%p, irq=%d)\n",
33f81009 397 KBUILD_MODNAME, priv->base, dev->irq);
881ff67a
BS
398 return 0;
399
400exit_free_device:
881ff67a 401 free_c_can_dev(dev);
881ff67a 402exit:
881ff67a
BS
403 dev_err(&pdev->dev, "probe failed\n");
404
405 return ret;
406}
407
3c8ac0f2 408static int c_can_plat_remove(struct platform_device *pdev)
881ff67a
BS
409{
410 struct net_device *dev = platform_get_drvdata(pdev);
881ff67a
BS
411
412 unregister_c_can_dev(dev);
881ff67a
BS
413
414 free_c_can_dev(dev);
881ff67a
BS
415
416 return 0;
417}
418
82120032
AC
419#ifdef CONFIG_PM
420static int c_can_suspend(struct platform_device *pdev, pm_message_t state)
421{
422 int ret;
423 struct net_device *ndev = platform_get_drvdata(pdev);
424 struct c_can_priv *priv = netdev_priv(ndev);
425
426 if (priv->type != BOSCH_D_CAN) {
427 dev_warn(&pdev->dev, "Not supported\n");
428 return 0;
429 }
430
431 if (netif_running(ndev)) {
432 netif_stop_queue(ndev);
433 netif_device_detach(ndev);
434 }
435
436 ret = c_can_power_down(ndev);
437 if (ret) {
438 netdev_err(ndev, "failed to enter power down mode\n");
439 return ret;
440 }
441
442 priv->can.state = CAN_STATE_SLEEPING;
443
444 return 0;
445}
446
447static int c_can_resume(struct platform_device *pdev)
448{
449 int ret;
450 struct net_device *ndev = platform_get_drvdata(pdev);
451 struct c_can_priv *priv = netdev_priv(ndev);
452
453 if (priv->type != BOSCH_D_CAN) {
454 dev_warn(&pdev->dev, "Not supported\n");
455 return 0;
456 }
457
458 ret = c_can_power_up(ndev);
459 if (ret) {
460 netdev_err(ndev, "Still in power down mode\n");
461 return ret;
462 }
463
464 priv->can.state = CAN_STATE_ERROR_ACTIVE;
465
466 if (netif_running(ndev)) {
467 netif_device_attach(ndev);
468 netif_start_queue(ndev);
469 }
470
471 return 0;
472}
473#else
474#define c_can_suspend NULL
475#define c_can_resume NULL
476#endif
477
881ff67a
BS
478static struct platform_driver c_can_plat_driver = {
479 .driver = {
480 .name = KBUILD_MODNAME,
b85f75ea 481 .of_match_table = c_can_of_table,
881ff67a
BS
482 },
483 .probe = c_can_plat_probe,
3c8ac0f2 484 .remove = c_can_plat_remove,
82120032
AC
485 .suspend = c_can_suspend,
486 .resume = c_can_resume,
69927fcc 487 .id_table = c_can_id_table,
881ff67a
BS
488};
489
871d3372 490module_platform_driver(c_can_plat_driver);
881ff67a
BS
491
492MODULE_AUTHOR("Bhupesh Sharma <bhupesh.sharma@st.com>");
493MODULE_LICENSE("GPL v2");
494MODULE_DESCRIPTION("Platform CAN bus driver for Bosch C_CAN controller");