2 * Blackfin On-Chip CAN Driver
4 * Copyright 2004-2009 Analog Devices Inc.
6 * Enter bugs at http://blackfin.uclinux.org/
8 * Licensed under the GPL-2 or later.
11 #include <linux/module.h>
12 #include <linux/kernel.h>
13 #include <linux/bitops.h>
14 #include <linux/interrupt.h>
15 #include <linux/errno.h>
16 #include <linux/netdevice.h>
17 #include <linux/skbuff.h>
18 #include <linux/platform_device.h>
20 #include <linux/can/dev.h>
21 #include <linux/can/error.h>
23 #include <asm/portmux.h>
25 #define DRV_NAME "bfin_can"
26 #define BFIN_CAN_TIMEOUT 100
27 #define TX_ECHO_SKB_MAX 1
29 /* transmit and receive channels */
30 #define TRANSMIT_CHL 24
31 #define RECEIVE_STD_CHL 0
32 #define RECEIVE_EXT_CHL 4
33 #define RECEIVE_RTR_CHL 8
34 #define RECEIVE_EXT_RTR_CHL 12
35 #define MAX_CHL_NUMBER 32
37 /* All Blackfin system MMRs are padded to 32bits even if the register
38 * itself is only 16bits. So use a helper macro to streamline this
40 #define __BFP(m) u16 m; u16 __pad_##m
42 /* bfin can registers layout */
43 struct bfin_can_mask_regs {
48 struct bfin_can_channel_regs {
49 /* data[0,2,4,6] -> data{0,1,2,3} while data[1,3,5,7] is padding */
57 struct bfin_can_regs {
58 /* global control and status registers */
59 __BFP(mc1); /* offset 0x00 */
60 __BFP(md1); /* offset 0x04 */
61 __BFP(trs1); /* offset 0x08 */
62 __BFP(trr1); /* offset 0x0c */
63 __BFP(ta1); /* offset 0x10 */
64 __BFP(aa1); /* offset 0x14 */
65 __BFP(rmp1); /* offset 0x18 */
66 __BFP(rml1); /* offset 0x1c */
67 __BFP(mbtif1); /* offset 0x20 */
68 __BFP(mbrif1); /* offset 0x24 */
69 __BFP(mbim1); /* offset 0x28 */
70 __BFP(rfh1); /* offset 0x2c */
71 __BFP(opss1); /* offset 0x30 */
73 __BFP(mc2); /* offset 0x40 */
74 __BFP(md2); /* offset 0x44 */
75 __BFP(trs2); /* offset 0x48 */
76 __BFP(trr2); /* offset 0x4c */
77 __BFP(ta2); /* offset 0x50 */
78 __BFP(aa2); /* offset 0x54 */
79 __BFP(rmp2); /* offset 0x58 */
80 __BFP(rml2); /* offset 0x5c */
81 __BFP(mbtif2); /* offset 0x60 */
82 __BFP(mbrif2); /* offset 0x64 */
83 __BFP(mbim2); /* offset 0x68 */
84 __BFP(rfh2); /* offset 0x6c */
85 __BFP(opss2); /* offset 0x70 */
87 __BFP(clock); /* offset 0x80 */
88 __BFP(timing); /* offset 0x84 */
89 __BFP(debug); /* offset 0x88 */
90 __BFP(status); /* offset 0x8c */
91 __BFP(cec); /* offset 0x90 */
92 __BFP(gis); /* offset 0x94 */
93 __BFP(gim); /* offset 0x98 */
94 __BFP(gif); /* offset 0x9c */
95 __BFP(control); /* offset 0xa0 */
96 __BFP(intr); /* offset 0xa4 */
97 __BFP(version); /* offset 0xa8 */
98 __BFP(mbtd); /* offset 0xac */
99 __BFP(ewr); /* offset 0xb0 */
100 __BFP(esr); /* offset 0xb4 */
102 __BFP(ucreg); /* offset 0xc0 */
103 __BFP(uccnt); /* offset 0xc4 */
104 __BFP(ucrc); /* offset 0xc8 */
105 __BFP(uccnf); /* offset 0xcc */
107 __BFP(version2); /* offset 0xd4 */
110 /* channel(mailbox) mask and message registers */
111 struct bfin_can_mask_regs msk[MAX_CHL_NUMBER]; /* offset 0x100 */
112 struct bfin_can_channel_regs chl[MAX_CHL_NUMBER]; /* offset 0x200 */
117 #define SRS 0x0001 /* Software Reset */
118 #define SER 0x0008 /* Stuff Error */
119 #define BOIM 0x0008 /* Enable Bus Off Interrupt */
120 #define CCR 0x0080 /* CAN Configuration Mode Request */
121 #define CCA 0x0080 /* Configuration Mode Acknowledge */
122 #define SAM 0x0080 /* Sampling */
123 #define AME 0x8000 /* Acceptance Mask Enable */
124 #define RMLIM 0x0080 /* Enable RX Message Lost Interrupt */
125 #define RMLIS 0x0080 /* RX Message Lost IRQ Status */
126 #define RTR 0x4000 /* Remote Frame Transmission Request */
127 #define BOIS 0x0008 /* Bus Off IRQ Status */
128 #define IDE 0x2000 /* Identifier Extension */
129 #define EPIS 0x0004 /* Error-Passive Mode IRQ Status */
130 #define EPIM 0x0004 /* Enable Error-Passive Mode Interrupt */
131 #define EWTIS 0x0001 /* TX Error Count IRQ Status */
132 #define EWRIS 0x0002 /* RX Error Count IRQ Status */
133 #define BEF 0x0040 /* Bit Error Flag */
134 #define FER 0x0080 /* Form Error Flag */
135 #define SMR 0x0020 /* Sleep Mode Request */
136 #define SMACK 0x0008 /* Sleep Mode Acknowledge */
139 * bfin can private data
141 struct bfin_can_priv {
142 struct can_priv can; /* must be the first member */
143 struct net_device *dev;
144 void __iomem *membase;
148 unsigned short *pin_list;
152 * bfin can timing parameters
154 static const struct can_bittiming_const bfin_can_bittiming_const = {
162 * Although the BRP field can be set to any value, it is recommended
163 * that the value be greater than or equal to 4, as restrictions
164 * apply to the bit timing configuration when BRP is less than 4.
171 static int bfin_can_set_bittiming(struct net_device *dev)
173 struct bfin_can_priv *priv = netdev_priv(dev);
174 struct bfin_can_regs __iomem *reg = priv->membase;
175 struct can_bittiming *bt = &priv->can.bittiming;
179 timing = ((bt->sjw - 1) << 8) | (bt->prop_seg + bt->phase_seg1 - 1) |
180 ((bt->phase_seg2 - 1) << 4);
183 * If the SAM bit is set, the input signal is oversampled three times
186 if (priv->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES)
189 writew(clk, ®->clock);
190 writew(timing, ®->timing);
192 netdev_info(dev, "setting CLOCK=0x%04x TIMING=0x%04x\n", clk, timing);
197 static void bfin_can_set_reset_mode(struct net_device *dev)
199 struct bfin_can_priv *priv = netdev_priv(dev);
200 struct bfin_can_regs __iomem *reg = priv->membase;
201 int timeout = BFIN_CAN_TIMEOUT;
204 /* disable interrupts */
205 writew(0, ®->mbim1);
206 writew(0, ®->mbim2);
207 writew(0, ®->gim);
209 /* reset can and enter configuration mode */
210 writew(SRS | CCR, ®->control);
211 writew(CCR, ®->control);
212 while (!(readw(®->control) & CCA)) {
214 if (--timeout == 0) {
215 netdev_err(dev, "fail to enter configuration mode\n");
221 * All mailbox configurations are marked as inactive
222 * by writing to CAN Mailbox Configuration Registers 1 and 2
223 * For all bits: 0 - Mailbox disabled, 1 - Mailbox enabled
225 writew(0, ®->mc1);
226 writew(0, ®->mc2);
228 /* Set Mailbox Direction */
229 writew(0xFFFF, ®->md1); /* mailbox 1-16 are RX */
230 writew(0, ®->md2); /* mailbox 17-32 are TX */
232 /* RECEIVE_STD_CHL */
233 for (i = 0; i < 2; i++) {
234 writew(0, ®->chl[RECEIVE_STD_CHL + i].id0);
235 writew(AME, ®->chl[RECEIVE_STD_CHL + i].id1);
236 writew(0, ®->chl[RECEIVE_STD_CHL + i].dlc);
237 writew(0x1FFF, ®->msk[RECEIVE_STD_CHL + i].amh);
238 writew(0xFFFF, ®->msk[RECEIVE_STD_CHL + i].aml);
241 /* RECEIVE_EXT_CHL */
242 for (i = 0; i < 2; i++) {
243 writew(0, ®->chl[RECEIVE_EXT_CHL + i].id0);
244 writew(AME | IDE, ®->chl[RECEIVE_EXT_CHL + i].id1);
245 writew(0, ®->chl[RECEIVE_EXT_CHL + i].dlc);
246 writew(0x1FFF, ®->msk[RECEIVE_EXT_CHL + i].amh);
247 writew(0xFFFF, ®->msk[RECEIVE_EXT_CHL + i].aml);
250 writew(BIT(TRANSMIT_CHL - 16), ®->mc2);
251 writew(BIT(RECEIVE_STD_CHL) + BIT(RECEIVE_EXT_CHL), ®->mc1);
253 priv->can.state = CAN_STATE_STOPPED;
256 static void bfin_can_set_normal_mode(struct net_device *dev)
258 struct bfin_can_priv *priv = netdev_priv(dev);
259 struct bfin_can_regs __iomem *reg = priv->membase;
260 int timeout = BFIN_CAN_TIMEOUT;
263 * leave configuration mode
265 writew(readw(®->control) & ~CCR, ®->control);
267 while (readw(®->status) & CCA) {
269 if (--timeout == 0) {
270 netdev_err(dev, "fail to leave configuration mode\n");
276 * clear _All_ tx and rx interrupts
278 writew(0xFFFF, ®->mbtif1);
279 writew(0xFFFF, ®->mbtif2);
280 writew(0xFFFF, ®->mbrif1);
281 writew(0xFFFF, ®->mbrif2);
284 * clear global interrupt status register
286 writew(0x7FF, ®->gis); /* overwrites with '1' */
289 * Initialize Interrupts
290 * - set bits in the mailbox interrupt mask register
291 * - global interrupt mask
293 writew(BIT(RECEIVE_STD_CHL) + BIT(RECEIVE_EXT_CHL), ®->mbim1);
294 writew(BIT(TRANSMIT_CHL - 16), ®->mbim2);
296 writew(EPIM | BOIM | RMLIM, ®->gim);
299 static void bfin_can_start(struct net_device *dev)
301 struct bfin_can_priv *priv = netdev_priv(dev);
303 /* enter reset mode */
304 if (priv->can.state != CAN_STATE_STOPPED)
305 bfin_can_set_reset_mode(dev);
307 /* leave reset mode */
308 bfin_can_set_normal_mode(dev);
311 static int bfin_can_set_mode(struct net_device *dev, enum can_mode mode)
316 if (netif_queue_stopped(dev))
317 netif_wake_queue(dev);
327 static int bfin_can_get_berr_counter(const struct net_device *dev,
328 struct can_berr_counter *bec)
330 struct bfin_can_priv *priv = netdev_priv(dev);
331 struct bfin_can_regs __iomem *reg = priv->membase;
333 u16 cec = readw(®->cec);
335 bec->txerr = cec >> 8;
341 static int bfin_can_start_xmit(struct sk_buff *skb, struct net_device *dev)
343 struct bfin_can_priv *priv = netdev_priv(dev);
344 struct bfin_can_regs __iomem *reg = priv->membase;
345 struct can_frame *cf = (struct can_frame *)skb->data;
346 u8 dlc = cf->can_dlc;
347 canid_t id = cf->can_id;
352 if (can_dropped_invalid_skb(dev, skb))
355 netif_stop_queue(dev);
358 if (id & CAN_EFF_FLAG) {
359 writew(id, ®->chl[TRANSMIT_CHL].id0);
360 val = ((id & 0x1FFF0000) >> 16) | IDE;
363 if (id & CAN_RTR_FLAG)
365 writew(val | AME, ®->chl[TRANSMIT_CHL].id1);
368 for (i = 0; i < 8; i += 2) {
369 val = ((7 - i) < dlc ? (data[7 - i]) : 0) +
370 ((6 - i) < dlc ? (data[6 - i] << 8) : 0);
371 writew(val, ®->chl[TRANSMIT_CHL].data[i]);
374 /* fill data length code */
375 writew(dlc, ®->chl[TRANSMIT_CHL].dlc);
377 can_put_echo_skb(skb, dev, 0);
379 /* set transmit request */
380 writew(BIT(TRANSMIT_CHL - 16), ®->trs2);
385 static void bfin_can_rx(struct net_device *dev, u16 isrc)
387 struct bfin_can_priv *priv = netdev_priv(dev);
388 struct net_device_stats *stats = &dev->stats;
389 struct bfin_can_regs __iomem *reg = priv->membase;
390 struct can_frame *cf;
396 skb = alloc_can_skb(dev, &cf);
401 if (isrc & BIT(RECEIVE_EXT_CHL)) {
402 /* extended frame format (EFF) */
403 cf->can_id = ((readw(®->chl[RECEIVE_EXT_CHL].id1)
405 + readw(®->chl[RECEIVE_EXT_CHL].id0);
406 cf->can_id |= CAN_EFF_FLAG;
407 obj = RECEIVE_EXT_CHL;
409 /* standard frame format (SFF) */
410 cf->can_id = (readw(®->chl[RECEIVE_STD_CHL].id1)
412 obj = RECEIVE_STD_CHL;
414 if (readw(®->chl[obj].id1) & RTR)
415 cf->can_id |= CAN_RTR_FLAG;
417 /* get data length code */
418 cf->can_dlc = get_can_dlc(readw(®->chl[obj].dlc) & 0xF);
421 for (i = 0; i < 8; i += 2) {
422 val = readw(®->chl[obj].data[i]);
423 cf->data[7 - i] = (7 - i) < cf->can_dlc ? val : 0;
424 cf->data[6 - i] = (6 - i) < cf->can_dlc ? (val >> 8) : 0;
428 stats->rx_bytes += cf->can_dlc;
432 static int bfin_can_err(struct net_device *dev, u16 isrc, u16 status)
434 struct bfin_can_priv *priv = netdev_priv(dev);
435 struct bfin_can_regs __iomem *reg = priv->membase;
436 struct net_device_stats *stats = &dev->stats;
437 struct can_frame *cf;
439 enum can_state state = priv->can.state;
441 skb = alloc_can_err_skb(dev, &cf);
446 /* data overrun interrupt */
447 netdev_dbg(dev, "data overrun interrupt\n");
448 cf->can_id |= CAN_ERR_CRTL;
449 cf->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
450 stats->rx_over_errors++;
455 netdev_dbg(dev, "bus-off mode interrupt\n");
456 state = CAN_STATE_BUS_OFF;
457 cf->can_id |= CAN_ERR_BUSOFF;
458 priv->can.can_stats.bus_off++;
463 /* error passive interrupt */
464 netdev_dbg(dev, "error passive interrupt\n");
465 state = CAN_STATE_ERROR_PASSIVE;
468 if ((isrc & EWTIS) || (isrc & EWRIS)) {
469 netdev_dbg(dev, "Error Warning Transmit/Receive Interrupt\n");
470 state = CAN_STATE_ERROR_WARNING;
473 if (state != priv->can.state && (state == CAN_STATE_ERROR_WARNING ||
474 state == CAN_STATE_ERROR_PASSIVE)) {
475 u16 cec = readw(®->cec);
479 cf->can_id |= CAN_ERR_CRTL;
480 if (state == CAN_STATE_ERROR_WARNING) {
481 priv->can.can_stats.error_warning++;
482 cf->data[1] = (txerr > rxerr) ?
483 CAN_ERR_CRTL_TX_WARNING :
484 CAN_ERR_CRTL_RX_WARNING;
486 priv->can.can_stats.error_passive++;
487 cf->data[1] = (txerr > rxerr) ?
488 CAN_ERR_CRTL_TX_PASSIVE :
489 CAN_ERR_CRTL_RX_PASSIVE;
494 priv->can.can_stats.bus_error++;
496 cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
499 cf->data[2] |= CAN_ERR_PROT_BIT;
500 else if (status & FER)
501 cf->data[2] |= CAN_ERR_PROT_FORM;
502 else if (status & SER)
503 cf->data[2] |= CAN_ERR_PROT_STUFF;
505 cf->data[2] |= CAN_ERR_PROT_UNSPEC;
508 priv->can.state = state;
511 stats->rx_bytes += cf->can_dlc;
517 static irqreturn_t bfin_can_interrupt(int irq, void *dev_id)
519 struct net_device *dev = dev_id;
520 struct bfin_can_priv *priv = netdev_priv(dev);
521 struct bfin_can_regs __iomem *reg = priv->membase;
522 struct net_device_stats *stats = &dev->stats;
525 if ((irq == priv->tx_irq) && readw(®->mbtif2)) {
526 /* transmission complete interrupt */
527 writew(0xFFFF, ®->mbtif2);
529 stats->tx_bytes += readw(®->chl[TRANSMIT_CHL].dlc);
530 can_get_echo_skb(dev, 0);
531 netif_wake_queue(dev);
532 } else if ((irq == priv->rx_irq) && readw(®->mbrif1)) {
533 /* receive interrupt */
534 isrc = readw(®->mbrif1);
535 writew(0xFFFF, ®->mbrif1);
536 bfin_can_rx(dev, isrc);
537 } else if ((irq == priv->err_irq) && readw(®->gis)) {
538 /* error interrupt */
539 isrc = readw(®->gis);
540 status = readw(®->esr);
541 writew(0x7FF, ®->gis);
542 bfin_can_err(dev, isrc, status);
550 static int bfin_can_open(struct net_device *dev)
552 struct bfin_can_priv *priv = netdev_priv(dev);
555 /* set chip into reset mode */
556 bfin_can_set_reset_mode(dev);
559 err = open_candev(dev);
563 /* register interrupt handler */
564 err = request_irq(priv->rx_irq, &bfin_can_interrupt, 0,
568 err = request_irq(priv->tx_irq, &bfin_can_interrupt, 0,
572 err = request_irq(priv->err_irq, &bfin_can_interrupt, 0,
573 "bfin-can-err", dev);
579 netif_start_queue(dev);
584 free_irq(priv->tx_irq, dev);
586 free_irq(priv->rx_irq, dev);
593 static int bfin_can_close(struct net_device *dev)
595 struct bfin_can_priv *priv = netdev_priv(dev);
597 netif_stop_queue(dev);
598 bfin_can_set_reset_mode(dev);
602 free_irq(priv->rx_irq, dev);
603 free_irq(priv->tx_irq, dev);
604 free_irq(priv->err_irq, dev);
609 static struct net_device *alloc_bfin_candev(void)
611 struct net_device *dev;
612 struct bfin_can_priv *priv;
614 dev = alloc_candev(sizeof(*priv), TX_ECHO_SKB_MAX);
618 priv = netdev_priv(dev);
621 priv->can.bittiming_const = &bfin_can_bittiming_const;
622 priv->can.do_set_bittiming = bfin_can_set_bittiming;
623 priv->can.do_set_mode = bfin_can_set_mode;
624 priv->can.do_get_berr_counter = bfin_can_get_berr_counter;
625 priv->can.ctrlmode_supported = CAN_CTRLMODE_3_SAMPLES;
630 static const struct net_device_ops bfin_can_netdev_ops = {
631 .ndo_open = bfin_can_open,
632 .ndo_stop = bfin_can_close,
633 .ndo_start_xmit = bfin_can_start_xmit,
634 .ndo_change_mtu = can_change_mtu,
637 static int bfin_can_probe(struct platform_device *pdev)
640 struct net_device *dev;
641 struct bfin_can_priv *priv;
642 struct resource *res_mem, *rx_irq, *tx_irq, *err_irq;
643 unsigned short *pdata;
645 pdata = dev_get_platdata(&pdev->dev);
647 dev_err(&pdev->dev, "No platform data provided!\n");
652 res_mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
653 rx_irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
654 tx_irq = platform_get_resource(pdev, IORESOURCE_IRQ, 1);
655 err_irq = platform_get_resource(pdev, IORESOURCE_IRQ, 2);
656 if (!res_mem || !rx_irq || !tx_irq || !err_irq) {
661 /* request peripheral pins */
662 err = peripheral_request_list(pdata, dev_name(&pdev->dev));
666 dev = alloc_bfin_candev();
669 goto exit_peri_pin_free;
672 priv = netdev_priv(dev);
674 priv->membase = devm_ioremap_resource(&pdev->dev, res_mem);
675 if (IS_ERR(priv->membase)) {
676 err = PTR_ERR(priv->membase);
677 goto exit_peri_pin_free;
680 priv->rx_irq = rx_irq->start;
681 priv->tx_irq = tx_irq->start;
682 priv->err_irq = err_irq->start;
683 priv->pin_list = pdata;
684 priv->can.clock.freq = get_sclk();
686 platform_set_drvdata(pdev, dev);
687 SET_NETDEV_DEV(dev, &pdev->dev);
689 dev->flags |= IFF_ECHO; /* we support local echo */
690 dev->netdev_ops = &bfin_can_netdev_ops;
692 bfin_can_set_reset_mode(dev);
694 err = register_candev(dev);
696 dev_err(&pdev->dev, "registering failed (err=%d)\n", err);
697 goto exit_candev_free;
701 "%s device registered"
702 "(®_base=%p, rx_irq=%d, tx_irq=%d, err_irq=%d, sclk=%d)\n",
703 DRV_NAME, priv->membase, priv->rx_irq,
704 priv->tx_irq, priv->err_irq, priv->can.clock.freq);
710 peripheral_free_list(pdata);
715 static int bfin_can_remove(struct platform_device *pdev)
717 struct net_device *dev = platform_get_drvdata(pdev);
718 struct bfin_can_priv *priv = netdev_priv(dev);
720 bfin_can_set_reset_mode(dev);
722 unregister_candev(dev);
724 peripheral_free_list(priv->pin_list);
731 static int bfin_can_suspend(struct platform_device *pdev, pm_message_t mesg)
733 struct net_device *dev = platform_get_drvdata(pdev);
734 struct bfin_can_priv *priv = netdev_priv(dev);
735 struct bfin_can_regs __iomem *reg = priv->membase;
736 int timeout = BFIN_CAN_TIMEOUT;
738 if (netif_running(dev)) {
739 /* enter sleep mode */
740 writew(readw(®->control) | SMR, ®->control);
741 while (!(readw(®->intr) & SMACK)) {
743 if (--timeout == 0) {
744 netdev_err(dev, "fail to enter sleep mode\n");
753 static int bfin_can_resume(struct platform_device *pdev)
755 struct net_device *dev = platform_get_drvdata(pdev);
756 struct bfin_can_priv *priv = netdev_priv(dev);
757 struct bfin_can_regs __iomem *reg = priv->membase;
759 if (netif_running(dev)) {
760 /* leave sleep mode */
761 writew(0, ®->intr);
767 #define bfin_can_suspend NULL
768 #define bfin_can_resume NULL
769 #endif /* CONFIG_PM */
771 static struct platform_driver bfin_can_driver = {
772 .probe = bfin_can_probe,
773 .remove = bfin_can_remove,
774 .suspend = bfin_can_suspend,
775 .resume = bfin_can_resume,
781 module_platform_driver(bfin_can_driver);
783 MODULE_AUTHOR("Barry Song <21cnbao@gmail.com>");
784 MODULE_LICENSE("GPL");
785 MODULE_DESCRIPTION("Blackfin on-chip CAN netdevice driver");
786 MODULE_ALIAS("platform:" DRV_NAME);