2 * at91_can.c - CAN network driver for AT91 SoC CAN controller
7 * This software may be distributed under the terms of the GNU General
8 * Public License ("GPL") version 2 as distributed in the 'COPYING'
9 * file from the main directory of the linux kernel source.
13 #include <linux/clk.h>
14 #include <linux/errno.h>
15 #include <linux/if_arp.h>
16 #include <linux/interrupt.h>
17 #include <linux/kernel.h>
18 #include <linux/module.h>
19 #include <linux/netdevice.h>
21 #include <linux/platform_device.h>
22 #include <linux/rtnetlink.h>
23 #include <linux/skbuff.h>
24 #include <linux/spinlock.h>
25 #include <linux/string.h>
26 #include <linux/types.h>
28 #include <linux/can/dev.h>
29 #include <linux/can/error.h>
30 #include <linux/can/led.h>
32 #define AT91_MB_MASK(i) ((1 << (i)) - 1)
34 /* Common registers */
49 /* Mailbox registers (0 <= i <= 15) */
50 #define AT91_MMR(i) (enum at91_reg)(0x200 + ((i) * 0x20))
51 #define AT91_MAM(i) (enum at91_reg)(0x204 + ((i) * 0x20))
52 #define AT91_MID(i) (enum at91_reg)(0x208 + ((i) * 0x20))
53 #define AT91_MFID(i) (enum at91_reg)(0x20C + ((i) * 0x20))
54 #define AT91_MSR(i) (enum at91_reg)(0x210 + ((i) * 0x20))
55 #define AT91_MDL(i) (enum at91_reg)(0x214 + ((i) * 0x20))
56 #define AT91_MDH(i) (enum at91_reg)(0x218 + ((i) * 0x20))
57 #define AT91_MCR(i) (enum at91_reg)(0x21C + ((i) * 0x20))
60 #define AT91_MR_CANEN BIT(0)
61 #define AT91_MR_LPM BIT(1)
62 #define AT91_MR_ABM BIT(2)
63 #define AT91_MR_OVL BIT(3)
64 #define AT91_MR_TEOF BIT(4)
65 #define AT91_MR_TTM BIT(5)
66 #define AT91_MR_TIMFRZ BIT(6)
67 #define AT91_MR_DRPT BIT(7)
69 #define AT91_SR_RBSY BIT(29)
71 #define AT91_MMR_PRIO_SHIFT (16)
73 #define AT91_MID_MIDE BIT(29)
75 #define AT91_MSR_MRTR BIT(20)
76 #define AT91_MSR_MABT BIT(22)
77 #define AT91_MSR_MRDY BIT(23)
78 #define AT91_MSR_MMI BIT(24)
80 #define AT91_MCR_MRTR BIT(20)
81 #define AT91_MCR_MTCR BIT(23)
85 AT91_MB_MODE_DISABLED = 0,
87 AT91_MB_MODE_RX_OVRWR = 2,
89 AT91_MB_MODE_CONSUMER = 4,
90 AT91_MB_MODE_PRODUCER = 5,
93 /* Interrupt mask bits */
94 #define AT91_IRQ_ERRA (1 << 16)
95 #define AT91_IRQ_WARN (1 << 17)
96 #define AT91_IRQ_ERRP (1 << 18)
97 #define AT91_IRQ_BOFF (1 << 19)
98 #define AT91_IRQ_SLEEP (1 << 20)
99 #define AT91_IRQ_WAKEUP (1 << 21)
100 #define AT91_IRQ_TOVF (1 << 22)
101 #define AT91_IRQ_TSTP (1 << 23)
102 #define AT91_IRQ_CERR (1 << 24)
103 #define AT91_IRQ_SERR (1 << 25)
104 #define AT91_IRQ_AERR (1 << 26)
105 #define AT91_IRQ_FERR (1 << 27)
106 #define AT91_IRQ_BERR (1 << 28)
108 #define AT91_IRQ_ERR_ALL (0x1fff0000)
109 #define AT91_IRQ_ERR_FRAME (AT91_IRQ_CERR | AT91_IRQ_SERR | \
110 AT91_IRQ_AERR | AT91_IRQ_FERR | AT91_IRQ_BERR)
111 #define AT91_IRQ_ERR_LINE (AT91_IRQ_ERRA | AT91_IRQ_WARN | \
112 AT91_IRQ_ERRP | AT91_IRQ_BOFF)
114 #define AT91_IRQ_ALL (0x1fffffff)
117 AT91_DEVTYPE_SAM9263,
121 struct at91_devtype_data {
122 unsigned int rx_first;
123 unsigned int rx_split;
124 unsigned int rx_last;
125 unsigned int tx_shift;
126 enum at91_devtype type;
130 struct can_priv can; /* must be the first member! */
131 struct napi_struct napi;
133 void __iomem *reg_base;
136 unsigned int tx_next;
137 unsigned int tx_echo;
138 unsigned int rx_next;
139 struct at91_devtype_data devtype_data;
142 struct at91_can_data *pdata;
147 static const struct at91_devtype_data at91_at91sam9263_data = {
152 .type = AT91_DEVTYPE_SAM9263,
155 static const struct at91_devtype_data at91_at91sam9x5_data = {
160 .type = AT91_DEVTYPE_SAM9X5,
163 static const struct can_bittiming_const at91_bittiming_const = {
164 .name = KBUILD_MODNAME,
175 #define AT91_IS(_model) \
176 static inline int at91_is_sam##_model(const struct at91_priv *priv) \
178 return priv->devtype_data.type == AT91_DEVTYPE_SAM##_model; \
184 static inline unsigned int get_mb_rx_first(const struct at91_priv *priv)
186 return priv->devtype_data.rx_first;
189 static inline unsigned int get_mb_rx_last(const struct at91_priv *priv)
191 return priv->devtype_data.rx_last;
194 static inline unsigned int get_mb_rx_split(const struct at91_priv *priv)
196 return priv->devtype_data.rx_split;
199 static inline unsigned int get_mb_rx_num(const struct at91_priv *priv)
201 return get_mb_rx_last(priv) - get_mb_rx_first(priv) + 1;
204 static inline unsigned int get_mb_rx_low_last(const struct at91_priv *priv)
206 return get_mb_rx_split(priv) - 1;
209 static inline unsigned int get_mb_rx_low_mask(const struct at91_priv *priv)
211 return AT91_MB_MASK(get_mb_rx_split(priv)) &
212 ~AT91_MB_MASK(get_mb_rx_first(priv));
215 static inline unsigned int get_mb_tx_shift(const struct at91_priv *priv)
217 return priv->devtype_data.tx_shift;
220 static inline unsigned int get_mb_tx_num(const struct at91_priv *priv)
222 return 1 << get_mb_tx_shift(priv);
225 static inline unsigned int get_mb_tx_first(const struct at91_priv *priv)
227 return get_mb_rx_last(priv) + 1;
230 static inline unsigned int get_mb_tx_last(const struct at91_priv *priv)
232 return get_mb_tx_first(priv) + get_mb_tx_num(priv) - 1;
235 static inline unsigned int get_next_prio_shift(const struct at91_priv *priv)
237 return get_mb_tx_shift(priv);
240 static inline unsigned int get_next_prio_mask(const struct at91_priv *priv)
242 return 0xf << get_mb_tx_shift(priv);
245 static inline unsigned int get_next_mb_mask(const struct at91_priv *priv)
247 return AT91_MB_MASK(get_mb_tx_shift(priv));
250 static inline unsigned int get_next_mask(const struct at91_priv *priv)
252 return get_next_mb_mask(priv) | get_next_prio_mask(priv);
255 static inline unsigned int get_irq_mb_rx(const struct at91_priv *priv)
257 return AT91_MB_MASK(get_mb_rx_last(priv) + 1) &
258 ~AT91_MB_MASK(get_mb_rx_first(priv));
261 static inline unsigned int get_irq_mb_tx(const struct at91_priv *priv)
263 return AT91_MB_MASK(get_mb_tx_last(priv) + 1) &
264 ~AT91_MB_MASK(get_mb_tx_first(priv));
267 static inline unsigned int get_tx_next_mb(const struct at91_priv *priv)
269 return (priv->tx_next & get_next_mb_mask(priv)) + get_mb_tx_first(priv);
272 static inline unsigned int get_tx_next_prio(const struct at91_priv *priv)
274 return (priv->tx_next >> get_next_prio_shift(priv)) & 0xf;
277 static inline unsigned int get_tx_echo_mb(const struct at91_priv *priv)
279 return (priv->tx_echo & get_next_mb_mask(priv)) + get_mb_tx_first(priv);
282 static inline u32 at91_read(const struct at91_priv *priv, enum at91_reg reg)
284 return readl_relaxed(priv->reg_base + reg);
287 static inline void at91_write(const struct at91_priv *priv, enum at91_reg reg,
290 writel_relaxed(value, priv->reg_base + reg);
293 static inline void set_mb_mode_prio(const struct at91_priv *priv,
294 unsigned int mb, enum at91_mb_mode mode, int prio)
296 at91_write(priv, AT91_MMR(mb), (mode << 24) | (prio << 16));
299 static inline void set_mb_mode(const struct at91_priv *priv, unsigned int mb,
300 enum at91_mb_mode mode)
302 set_mb_mode_prio(priv, mb, mode, 0);
305 static inline u32 at91_can_id_to_reg_mid(canid_t can_id)
309 if (can_id & CAN_EFF_FLAG)
310 reg_mid = (can_id & CAN_EFF_MASK) | AT91_MID_MIDE;
312 reg_mid = (can_id & CAN_SFF_MASK) << 18;
317 static void at91_setup_mailboxes(struct net_device *dev)
319 struct at91_priv *priv = netdev_priv(dev);
324 * Due to a chip bug (errata 50.2.6.3 & 50.3.5.3) the first
325 * mailbox is disabled. The next 11 mailboxes are used as a
326 * reception FIFO. The last mailbox is configured with
327 * overwrite option. The overwrite flag indicates a FIFO
330 reg_mid = at91_can_id_to_reg_mid(priv->mb0_id);
331 for (i = 0; i < get_mb_rx_first(priv); i++) {
332 set_mb_mode(priv, i, AT91_MB_MODE_DISABLED);
333 at91_write(priv, AT91_MID(i), reg_mid);
334 at91_write(priv, AT91_MCR(i), 0x0); /* clear dlc */
337 for (i = get_mb_rx_first(priv); i < get_mb_rx_last(priv); i++)
338 set_mb_mode(priv, i, AT91_MB_MODE_RX);
339 set_mb_mode(priv, get_mb_rx_last(priv), AT91_MB_MODE_RX_OVRWR);
341 /* reset acceptance mask and id register */
342 for (i = get_mb_rx_first(priv); i <= get_mb_rx_last(priv); i++) {
343 at91_write(priv, AT91_MAM(i), 0x0);
344 at91_write(priv, AT91_MID(i), AT91_MID_MIDE);
347 /* The last 4 mailboxes are used for transmitting. */
348 for (i = get_mb_tx_first(priv); i <= get_mb_tx_last(priv); i++)
349 set_mb_mode_prio(priv, i, AT91_MB_MODE_TX, 0);
351 /* Reset tx and rx helper pointers */
352 priv->tx_next = priv->tx_echo = 0;
353 priv->rx_next = get_mb_rx_first(priv);
356 static int at91_set_bittiming(struct net_device *dev)
358 const struct at91_priv *priv = netdev_priv(dev);
359 const struct can_bittiming *bt = &priv->can.bittiming;
362 reg_br = ((priv->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES) ? 1 << 24 : 0) |
363 ((bt->brp - 1) << 16) | ((bt->sjw - 1) << 12) |
364 ((bt->prop_seg - 1) << 8) | ((bt->phase_seg1 - 1) << 4) |
365 ((bt->phase_seg2 - 1) << 0);
367 netdev_info(dev, "writing AT91_BR: 0x%08x\n", reg_br);
369 at91_write(priv, AT91_BR, reg_br);
374 static int at91_get_berr_counter(const struct net_device *dev,
375 struct can_berr_counter *bec)
377 const struct at91_priv *priv = netdev_priv(dev);
378 u32 reg_ecr = at91_read(priv, AT91_ECR);
380 bec->rxerr = reg_ecr & 0xff;
381 bec->txerr = reg_ecr >> 16;
386 static void at91_chip_start(struct net_device *dev)
388 struct at91_priv *priv = netdev_priv(dev);
391 /* disable interrupts */
392 at91_write(priv, AT91_IDR, AT91_IRQ_ALL);
395 reg_mr = at91_read(priv, AT91_MR);
396 at91_write(priv, AT91_MR, reg_mr & ~AT91_MR_CANEN);
398 at91_set_bittiming(dev);
399 at91_setup_mailboxes(dev);
402 if (priv->can.ctrlmode & CAN_CTRLMODE_LISTENONLY)
403 reg_mr = AT91_MR_CANEN | AT91_MR_ABM;
405 reg_mr = AT91_MR_CANEN;
406 at91_write(priv, AT91_MR, reg_mr);
408 priv->can.state = CAN_STATE_ERROR_ACTIVE;
410 /* Enable interrupts */
411 reg_ier = get_irq_mb_rx(priv) | AT91_IRQ_ERRP | AT91_IRQ_ERR_FRAME;
412 at91_write(priv, AT91_IDR, AT91_IRQ_ALL);
413 at91_write(priv, AT91_IER, reg_ier);
416 static void at91_chip_stop(struct net_device *dev, enum can_state state)
418 struct at91_priv *priv = netdev_priv(dev);
421 /* disable interrupts */
422 at91_write(priv, AT91_IDR, AT91_IRQ_ALL);
424 reg_mr = at91_read(priv, AT91_MR);
425 at91_write(priv, AT91_MR, reg_mr & ~AT91_MR_CANEN);
427 priv->can.state = state;
431 * theory of operation:
433 * According to the datasheet priority 0 is the highest priority, 15
434 * is the lowest. If two mailboxes have the same priority level the
435 * message of the mailbox with the lowest number is sent first.
437 * We use the first TX mailbox (AT91_MB_TX_FIRST) with prio 0, then
438 * the next mailbox with prio 0, and so on, until all mailboxes are
439 * used. Then we start from the beginning with mailbox
440 * AT91_MB_TX_FIRST, but with prio 1, mailbox AT91_MB_TX_FIRST + 1
441 * prio 1. When we reach the last mailbox with prio 15, we have to
442 * stop sending, waiting for all messages to be delivered, then start
443 * again with mailbox AT91_MB_TX_FIRST prio 0.
445 * We use the priv->tx_next as counter for the next transmission
446 * mailbox, but without the offset AT91_MB_TX_FIRST. The lower bits
447 * encode the mailbox number, the upper 4 bits the mailbox priority:
449 * priv->tx_next = (prio << get_next_prio_shift(priv)) |
450 * (mb - get_mb_tx_first(priv));
453 static netdev_tx_t at91_start_xmit(struct sk_buff *skb, struct net_device *dev)
455 struct at91_priv *priv = netdev_priv(dev);
456 struct net_device_stats *stats = &dev->stats;
457 struct can_frame *cf = (struct can_frame *)skb->data;
458 unsigned int mb, prio;
459 u32 reg_mid, reg_mcr;
461 if (can_dropped_invalid_skb(dev, skb))
464 mb = get_tx_next_mb(priv);
465 prio = get_tx_next_prio(priv);
467 if (unlikely(!(at91_read(priv, AT91_MSR(mb)) & AT91_MSR_MRDY))) {
468 netif_stop_queue(dev);
470 netdev_err(dev, "BUG! TX buffer full when queue awake!\n");
471 return NETDEV_TX_BUSY;
473 reg_mid = at91_can_id_to_reg_mid(cf->can_id);
474 reg_mcr = ((cf->can_id & CAN_RTR_FLAG) ? AT91_MCR_MRTR : 0) |
475 (cf->can_dlc << 16) | AT91_MCR_MTCR;
477 /* disable MB while writing ID (see datasheet) */
478 set_mb_mode(priv, mb, AT91_MB_MODE_DISABLED);
479 at91_write(priv, AT91_MID(mb), reg_mid);
480 set_mb_mode_prio(priv, mb, AT91_MB_MODE_TX, prio);
482 at91_write(priv, AT91_MDL(mb), *(u32 *)(cf->data + 0));
483 at91_write(priv, AT91_MDH(mb), *(u32 *)(cf->data + 4));
485 /* This triggers transmission */
486 at91_write(priv, AT91_MCR(mb), reg_mcr);
488 stats->tx_bytes += cf->can_dlc;
490 /* _NOTE_: subtract AT91_MB_TX_FIRST offset from mb! */
491 can_put_echo_skb(skb, dev, mb - get_mb_tx_first(priv));
494 * we have to stop the queue and deliver all messages in case
495 * of a prio+mb counter wrap around. This is the case if
496 * tx_next buffer prio and mailbox equals 0.
498 * also stop the queue if next buffer is still in use
502 if (!(at91_read(priv, AT91_MSR(get_tx_next_mb(priv))) &
504 (priv->tx_next & get_next_mask(priv)) == 0)
505 netif_stop_queue(dev);
507 /* Enable interrupt for this mailbox */
508 at91_write(priv, AT91_IER, 1 << mb);
514 * at91_activate_rx_low - activate lower rx mailboxes
517 * Reenables the lower mailboxes for reception of new CAN messages
519 static inline void at91_activate_rx_low(const struct at91_priv *priv)
521 u32 mask = get_mb_rx_low_mask(priv);
522 at91_write(priv, AT91_TCR, mask);
526 * at91_activate_rx_mb - reactive single rx mailbox
528 * @mb: mailbox to reactivate
530 * Reenables given mailbox for reception of new CAN messages
532 static inline void at91_activate_rx_mb(const struct at91_priv *priv,
536 at91_write(priv, AT91_TCR, mask);
540 * at91_rx_overflow_err - send error frame due to rx overflow
543 static void at91_rx_overflow_err(struct net_device *dev)
545 struct net_device_stats *stats = &dev->stats;
547 struct can_frame *cf;
549 netdev_dbg(dev, "RX buffer overflow\n");
550 stats->rx_over_errors++;
553 skb = alloc_can_err_skb(dev, &cf);
557 cf->can_id |= CAN_ERR_CRTL;
558 cf->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
561 stats->rx_bytes += cf->can_dlc;
562 netif_receive_skb(skb);
566 * at91_read_mb - read CAN msg from mailbox (lowlevel impl)
568 * @mb: mailbox number to read from
569 * @cf: can frame where to store message
571 * Reads a CAN message from the given mailbox and stores data into
572 * given can frame. "mb" and "cf" must be valid.
574 static void at91_read_mb(struct net_device *dev, unsigned int mb,
575 struct can_frame *cf)
577 const struct at91_priv *priv = netdev_priv(dev);
578 u32 reg_msr, reg_mid;
580 reg_mid = at91_read(priv, AT91_MID(mb));
581 if (reg_mid & AT91_MID_MIDE)
582 cf->can_id = ((reg_mid >> 0) & CAN_EFF_MASK) | CAN_EFF_FLAG;
584 cf->can_id = (reg_mid >> 18) & CAN_SFF_MASK;
586 reg_msr = at91_read(priv, AT91_MSR(mb));
587 cf->can_dlc = get_can_dlc((reg_msr >> 16) & 0xf);
589 if (reg_msr & AT91_MSR_MRTR)
590 cf->can_id |= CAN_RTR_FLAG;
592 *(u32 *)(cf->data + 0) = at91_read(priv, AT91_MDL(mb));
593 *(u32 *)(cf->data + 4) = at91_read(priv, AT91_MDH(mb));
596 /* allow RX of extended frames */
597 at91_write(priv, AT91_MID(mb), AT91_MID_MIDE);
599 if (unlikely(mb == get_mb_rx_last(priv) && reg_msr & AT91_MSR_MMI))
600 at91_rx_overflow_err(dev);
604 * at91_read_msg - read CAN message from mailbox
606 * @mb: mail box to read from
608 * Reads a CAN message from given mailbox, and put into linux network
609 * RX queue, does all housekeeping chores (stats, ...)
611 static void at91_read_msg(struct net_device *dev, unsigned int mb)
613 struct net_device_stats *stats = &dev->stats;
614 struct can_frame *cf;
617 skb = alloc_can_skb(dev, &cf);
618 if (unlikely(!skb)) {
623 at91_read_mb(dev, mb, cf);
626 stats->rx_bytes += cf->can_dlc;
627 netif_receive_skb(skb);
629 can_led_event(dev, CAN_LED_EVENT_RX);
633 * at91_poll_rx - read multiple CAN messages from mailboxes
635 * @quota: max number of pkgs we're allowed to receive
637 * Theory of Operation:
639 * About 3/4 of the mailboxes (get_mb_rx_first()...get_mb_rx_last())
640 * on the chip are reserved for RX. We split them into 2 groups. The
641 * lower group ranges from get_mb_rx_first() to get_mb_rx_low_last().
643 * Like it or not, but the chip always saves a received CAN message
644 * into the first free mailbox it finds (starting with the
645 * lowest). This makes it very difficult to read the messages in the
646 * right order from the chip. This is how we work around that problem:
648 * The first message goes into mb nr. 1 and issues an interrupt. All
649 * rx ints are disabled in the interrupt handler and a napi poll is
650 * scheduled. We read the mailbox, but do _not_ reenable the mb (to
651 * receive another message).
656 * +-+-+-+-+-+-+-+-++-+-+-+-+
657 * | |x|x|x|x|x|x|x|| | | | |
658 * +-+-+-+-+-+-+-+-++-+-+-+-+
659 * 0 0 0 0 0 0 0 0 0 0 1 1 \ mail
660 * 0 1 2 3 4 5 6 7 8 9 0 1 / box
664 * unused, due to chip bug
666 * The variable priv->rx_next points to the next mailbox to read a
667 * message from. As long we're in the lower mailboxes we just read the
668 * mailbox but not reenable it.
670 * With completion of the last of the lower mailboxes, we reenable the
671 * whole first group, but continue to look for filled mailboxes in the
672 * upper mailboxes. Imagine the second group like overflow mailboxes,
673 * which takes CAN messages if the lower goup is full. While in the
674 * upper group we reenable the mailbox right after reading it. Giving
675 * the chip more room to store messages.
677 * After finishing we look again in the lower group if we've still
681 static int at91_poll_rx(struct net_device *dev, int quota)
683 struct at91_priv *priv = netdev_priv(dev);
684 u32 reg_sr = at91_read(priv, AT91_SR);
685 const unsigned long *addr = (unsigned long *)®_sr;
689 if (priv->rx_next > get_mb_rx_low_last(priv) &&
690 reg_sr & get_mb_rx_low_mask(priv))
692 "order of incoming frames cannot be guaranteed\n");
695 for (mb = find_next_bit(addr, get_mb_tx_first(priv), priv->rx_next);
696 mb < get_mb_tx_first(priv) && quota > 0;
697 reg_sr = at91_read(priv, AT91_SR),
698 mb = find_next_bit(addr, get_mb_tx_first(priv), ++priv->rx_next)) {
699 at91_read_msg(dev, mb);
701 /* reactivate mailboxes */
702 if (mb == get_mb_rx_low_last(priv))
703 /* all lower mailboxed, if just finished it */
704 at91_activate_rx_low(priv);
705 else if (mb > get_mb_rx_low_last(priv))
706 /* only the mailbox we read */
707 at91_activate_rx_mb(priv, mb);
713 /* upper group completed, look again in lower */
714 if (priv->rx_next > get_mb_rx_low_last(priv) &&
715 quota > 0 && mb > get_mb_rx_last(priv)) {
716 priv->rx_next = get_mb_rx_first(priv);
723 static void at91_poll_err_frame(struct net_device *dev,
724 struct can_frame *cf, u32 reg_sr)
726 struct at91_priv *priv = netdev_priv(dev);
729 if (reg_sr & AT91_IRQ_CERR) {
730 netdev_dbg(dev, "CERR irq\n");
731 dev->stats.rx_errors++;
732 priv->can.can_stats.bus_error++;
733 cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
737 if (reg_sr & AT91_IRQ_SERR) {
738 netdev_dbg(dev, "SERR irq\n");
739 dev->stats.rx_errors++;
740 priv->can.can_stats.bus_error++;
741 cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
742 cf->data[2] |= CAN_ERR_PROT_STUFF;
745 /* Acknowledgement Error */
746 if (reg_sr & AT91_IRQ_AERR) {
747 netdev_dbg(dev, "AERR irq\n");
748 dev->stats.tx_errors++;
749 cf->can_id |= CAN_ERR_ACK;
753 if (reg_sr & AT91_IRQ_FERR) {
754 netdev_dbg(dev, "FERR irq\n");
755 dev->stats.rx_errors++;
756 priv->can.can_stats.bus_error++;
757 cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
758 cf->data[2] |= CAN_ERR_PROT_FORM;
762 if (reg_sr & AT91_IRQ_BERR) {
763 netdev_dbg(dev, "BERR irq\n");
764 dev->stats.tx_errors++;
765 priv->can.can_stats.bus_error++;
766 cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
767 cf->data[2] |= CAN_ERR_PROT_BIT;
771 static int at91_poll_err(struct net_device *dev, int quota, u32 reg_sr)
774 struct can_frame *cf;
779 skb = alloc_can_err_skb(dev, &cf);
783 at91_poll_err_frame(dev, cf, reg_sr);
785 dev->stats.rx_packets++;
786 dev->stats.rx_bytes += cf->can_dlc;
787 netif_receive_skb(skb);
792 static int at91_poll(struct napi_struct *napi, int quota)
794 struct net_device *dev = napi->dev;
795 const struct at91_priv *priv = netdev_priv(dev);
796 u32 reg_sr = at91_read(priv, AT91_SR);
799 if (reg_sr & get_irq_mb_rx(priv))
800 work_done += at91_poll_rx(dev, quota - work_done);
803 * The error bits are clear on read,
804 * so use saved value from irq handler.
806 reg_sr |= priv->reg_sr;
807 if (reg_sr & AT91_IRQ_ERR_FRAME)
808 work_done += at91_poll_err(dev, quota - work_done, reg_sr);
810 if (work_done < quota) {
811 /* enable IRQs for frame errors and all mailboxes >= rx_next */
812 u32 reg_ier = AT91_IRQ_ERR_FRAME;
813 reg_ier |= get_irq_mb_rx(priv) & ~AT91_MB_MASK(priv->rx_next);
816 at91_write(priv, AT91_IER, reg_ier);
823 * theory of operation:
825 * priv->tx_echo holds the number of the oldest can_frame put for
826 * transmission into the hardware, but not yet ACKed by the CAN tx
829 * We iterate from priv->tx_echo to priv->tx_next and check if the
830 * packet has been transmitted, echo it back to the CAN framework. If
831 * we discover a not yet transmitted package, stop looking for more.
834 static void at91_irq_tx(struct net_device *dev, u32 reg_sr)
836 struct at91_priv *priv = netdev_priv(dev);
840 /* masking of reg_sr not needed, already done by at91_irq */
842 for (/* nix */; (priv->tx_next - priv->tx_echo) > 0; priv->tx_echo++) {
843 mb = get_tx_echo_mb(priv);
845 /* no event in mailbox? */
846 if (!(reg_sr & (1 << mb)))
849 /* Disable irq for this TX mailbox */
850 at91_write(priv, AT91_IDR, 1 << mb);
853 * only echo if mailbox signals us a transfer
854 * complete (MSR_MRDY). Otherwise it's a tansfer
855 * abort. "can_bus_off()" takes care about the skbs
856 * parked in the echo queue.
858 reg_msr = at91_read(priv, AT91_MSR(mb));
859 if (likely(reg_msr & AT91_MSR_MRDY &&
860 ~reg_msr & AT91_MSR_MABT)) {
861 /* _NOTE_: subtract AT91_MB_TX_FIRST offset from mb! */
862 can_get_echo_skb(dev, mb - get_mb_tx_first(priv));
863 dev->stats.tx_packets++;
864 can_led_event(dev, CAN_LED_EVENT_TX);
869 * restart queue if we don't have a wrap around but restart if
870 * we get a TX int for the last can frame directly before a
873 if ((priv->tx_next & get_next_mask(priv)) != 0 ||
874 (priv->tx_echo & get_next_mask(priv)) == 0)
875 netif_wake_queue(dev);
878 static void at91_irq_err_state(struct net_device *dev,
879 struct can_frame *cf, enum can_state new_state)
881 struct at91_priv *priv = netdev_priv(dev);
882 u32 reg_idr = 0, reg_ier = 0;
883 struct can_berr_counter bec;
885 at91_get_berr_counter(dev, &bec);
887 switch (priv->can.state) {
888 case CAN_STATE_ERROR_ACTIVE:
891 * to : ERROR_WARNING, ERROR_PASSIVE, BUS_OFF
892 * => : there was a warning int
894 if (new_state >= CAN_STATE_ERROR_WARNING &&
895 new_state <= CAN_STATE_BUS_OFF) {
896 netdev_dbg(dev, "Error Warning IRQ\n");
897 priv->can.can_stats.error_warning++;
899 cf->can_id |= CAN_ERR_CRTL;
900 cf->data[1] = (bec.txerr > bec.rxerr) ?
901 CAN_ERR_CRTL_TX_WARNING :
902 CAN_ERR_CRTL_RX_WARNING;
904 case CAN_STATE_ERROR_WARNING: /* fallthrough */
906 * from: ERROR_ACTIVE, ERROR_WARNING
907 * to : ERROR_PASSIVE, BUS_OFF
908 * => : error passive int
910 if (new_state >= CAN_STATE_ERROR_PASSIVE &&
911 new_state <= CAN_STATE_BUS_OFF) {
912 netdev_dbg(dev, "Error Passive IRQ\n");
913 priv->can.can_stats.error_passive++;
915 cf->can_id |= CAN_ERR_CRTL;
916 cf->data[1] = (bec.txerr > bec.rxerr) ?
917 CAN_ERR_CRTL_TX_PASSIVE :
918 CAN_ERR_CRTL_RX_PASSIVE;
921 case CAN_STATE_BUS_OFF:
924 * to : ERROR_ACTIVE, ERROR_WARNING, ERROR_PASSIVE
926 if (new_state <= CAN_STATE_ERROR_PASSIVE) {
927 cf->can_id |= CAN_ERR_RESTARTED;
929 netdev_dbg(dev, "restarted\n");
930 priv->can.can_stats.restarts++;
932 netif_carrier_on(dev);
933 netif_wake_queue(dev);
941 /* process state changes depending on the new state */
943 case CAN_STATE_ERROR_ACTIVE:
945 * actually we want to enable AT91_IRQ_WARN here, but
946 * it screws up the system under certain
947 * circumstances. so just enable AT91_IRQ_ERRP, thus
950 netdev_dbg(dev, "Error Active\n");
951 cf->can_id |= CAN_ERR_PROT;
952 cf->data[2] = CAN_ERR_PROT_ACTIVE;
953 case CAN_STATE_ERROR_WARNING: /* fallthrough */
954 reg_idr = AT91_IRQ_ERRA | AT91_IRQ_WARN | AT91_IRQ_BOFF;
955 reg_ier = AT91_IRQ_ERRP;
957 case CAN_STATE_ERROR_PASSIVE:
958 reg_idr = AT91_IRQ_ERRA | AT91_IRQ_WARN | AT91_IRQ_ERRP;
959 reg_ier = AT91_IRQ_BOFF;
961 case CAN_STATE_BUS_OFF:
962 reg_idr = AT91_IRQ_ERRA | AT91_IRQ_ERRP |
963 AT91_IRQ_WARN | AT91_IRQ_BOFF;
966 cf->can_id |= CAN_ERR_BUSOFF;
968 netdev_dbg(dev, "bus-off\n");
969 netif_carrier_off(dev);
970 priv->can.can_stats.bus_off++;
972 /* turn off chip, if restart is disabled */
973 if (!priv->can.restart_ms) {
974 at91_chip_stop(dev, CAN_STATE_BUS_OFF);
982 at91_write(priv, AT91_IDR, reg_idr);
983 at91_write(priv, AT91_IER, reg_ier);
986 static int at91_get_state_by_bec(const struct net_device *dev,
987 enum can_state *state)
989 struct can_berr_counter bec;
992 err = at91_get_berr_counter(dev, &bec);
996 if (bec.txerr < 96 && bec.rxerr < 96)
997 *state = CAN_STATE_ERROR_ACTIVE;
998 else if (bec.txerr < 128 && bec.rxerr < 128)
999 *state = CAN_STATE_ERROR_WARNING;
1000 else if (bec.txerr < 256 && bec.rxerr < 256)
1001 *state = CAN_STATE_ERROR_PASSIVE;
1003 *state = CAN_STATE_BUS_OFF;
1009 static void at91_irq_err(struct net_device *dev)
1011 struct at91_priv *priv = netdev_priv(dev);
1012 struct sk_buff *skb;
1013 struct can_frame *cf;
1014 enum can_state new_state;
1018 if (at91_is_sam9263(priv)) {
1019 reg_sr = at91_read(priv, AT91_SR);
1021 /* we need to look at the unmasked reg_sr */
1022 if (unlikely(reg_sr & AT91_IRQ_BOFF))
1023 new_state = CAN_STATE_BUS_OFF;
1024 else if (unlikely(reg_sr & AT91_IRQ_ERRP))
1025 new_state = CAN_STATE_ERROR_PASSIVE;
1026 else if (unlikely(reg_sr & AT91_IRQ_WARN))
1027 new_state = CAN_STATE_ERROR_WARNING;
1028 else if (likely(reg_sr & AT91_IRQ_ERRA))
1029 new_state = CAN_STATE_ERROR_ACTIVE;
1031 netdev_err(dev, "BUG! hardware in undefined state\n");
1035 err = at91_get_state_by_bec(dev, &new_state);
1040 /* state hasn't changed */
1041 if (likely(new_state == priv->can.state))
1044 skb = alloc_can_err_skb(dev, &cf);
1048 at91_irq_err_state(dev, cf, new_state);
1050 dev->stats.rx_packets++;
1051 dev->stats.rx_bytes += cf->can_dlc;
1054 priv->can.state = new_state;
1060 static irqreturn_t at91_irq(int irq, void *dev_id)
1062 struct net_device *dev = dev_id;
1063 struct at91_priv *priv = netdev_priv(dev);
1064 irqreturn_t handled = IRQ_NONE;
1065 u32 reg_sr, reg_imr;
1067 reg_sr = at91_read(priv, AT91_SR);
1068 reg_imr = at91_read(priv, AT91_IMR);
1070 /* Ignore masked interrupts */
1075 handled = IRQ_HANDLED;
1077 /* Receive or error interrupt? -> napi */
1078 if (reg_sr & (get_irq_mb_rx(priv) | AT91_IRQ_ERR_FRAME)) {
1080 * The error bits are clear on read,
1081 * save for later use.
1083 priv->reg_sr = reg_sr;
1084 at91_write(priv, AT91_IDR,
1085 get_irq_mb_rx(priv) | AT91_IRQ_ERR_FRAME);
1086 napi_schedule(&priv->napi);
1089 /* Transmission complete interrupt */
1090 if (reg_sr & get_irq_mb_tx(priv))
1091 at91_irq_tx(dev, reg_sr);
1099 static int at91_open(struct net_device *dev)
1101 struct at91_priv *priv = netdev_priv(dev);
1104 err = clk_prepare_enable(priv->clk);
1108 /* check or determine and set bittime */
1109 err = open_candev(dev);
1113 /* register interrupt handler */
1114 if (request_irq(dev->irq, at91_irq, IRQF_SHARED,
1120 can_led_event(dev, CAN_LED_EVENT_OPEN);
1122 /* start chip and queuing */
1123 at91_chip_start(dev);
1124 napi_enable(&priv->napi);
1125 netif_start_queue(dev);
1132 clk_disable_unprepare(priv->clk);
1138 * stop CAN bus activity
1140 static int at91_close(struct net_device *dev)
1142 struct at91_priv *priv = netdev_priv(dev);
1144 netif_stop_queue(dev);
1145 napi_disable(&priv->napi);
1146 at91_chip_stop(dev, CAN_STATE_STOPPED);
1148 free_irq(dev->irq, dev);
1149 clk_disable_unprepare(priv->clk);
1153 can_led_event(dev, CAN_LED_EVENT_STOP);
1158 static int at91_set_mode(struct net_device *dev, enum can_mode mode)
1161 case CAN_MODE_START:
1162 at91_chip_start(dev);
1163 netif_wake_queue(dev);
1173 static const struct net_device_ops at91_netdev_ops = {
1174 .ndo_open = at91_open,
1175 .ndo_stop = at91_close,
1176 .ndo_start_xmit = at91_start_xmit,
1177 .ndo_change_mtu = can_change_mtu,
1180 static ssize_t at91_sysfs_show_mb0_id(struct device *dev,
1181 struct device_attribute *attr, char *buf)
1183 struct at91_priv *priv = netdev_priv(to_net_dev(dev));
1185 if (priv->mb0_id & CAN_EFF_FLAG)
1186 return snprintf(buf, PAGE_SIZE, "0x%08x\n", priv->mb0_id);
1188 return snprintf(buf, PAGE_SIZE, "0x%03x\n", priv->mb0_id);
1191 static ssize_t at91_sysfs_set_mb0_id(struct device *dev,
1192 struct device_attribute *attr, const char *buf, size_t count)
1194 struct net_device *ndev = to_net_dev(dev);
1195 struct at91_priv *priv = netdev_priv(ndev);
1196 unsigned long can_id;
1202 if (ndev->flags & IFF_UP) {
1207 err = kstrtoul(buf, 0, &can_id);
1213 if (can_id & CAN_EFF_FLAG)
1214 can_id &= CAN_EFF_MASK | CAN_EFF_FLAG;
1216 can_id &= CAN_SFF_MASK;
1218 priv->mb0_id = can_id;
1226 static DEVICE_ATTR(mb0_id, S_IWUSR | S_IRUGO,
1227 at91_sysfs_show_mb0_id, at91_sysfs_set_mb0_id);
1229 static struct attribute *at91_sysfs_attrs[] = {
1230 &dev_attr_mb0_id.attr,
1234 static struct attribute_group at91_sysfs_attr_group = {
1235 .attrs = at91_sysfs_attrs,
1238 #if defined(CONFIG_OF)
1239 static const struct of_device_id at91_can_dt_ids[] = {
1241 .compatible = "atmel,at91sam9x5-can",
1242 .data = &at91_at91sam9x5_data,
1244 .compatible = "atmel,at91sam9263-can",
1245 .data = &at91_at91sam9263_data,
1250 MODULE_DEVICE_TABLE(of, at91_can_dt_ids);
1253 static const struct at91_devtype_data *at91_can_get_driver_data(struct platform_device *pdev)
1255 if (pdev->dev.of_node) {
1256 const struct of_device_id *match;
1258 match = of_match_node(at91_can_dt_ids, pdev->dev.of_node);
1260 dev_err(&pdev->dev, "no matching node found in dtb\n");
1263 return (const struct at91_devtype_data *)match->data;
1265 return (const struct at91_devtype_data *)
1266 platform_get_device_id(pdev)->driver_data;
1269 static int at91_can_probe(struct platform_device *pdev)
1271 const struct at91_devtype_data *devtype_data;
1272 struct net_device *dev;
1273 struct at91_priv *priv;
1274 struct resource *res;
1279 devtype_data = at91_can_get_driver_data(pdev);
1280 if (!devtype_data) {
1281 dev_err(&pdev->dev, "no driver data\n");
1286 clk = clk_get(&pdev->dev, "can_clk");
1288 dev_err(&pdev->dev, "no clock defined\n");
1293 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1294 irq = platform_get_irq(pdev, 0);
1295 if (!res || irq <= 0) {
1300 if (!request_mem_region(res->start,
1307 addr = ioremap_nocache(res->start, resource_size(res));
1313 dev = alloc_candev(sizeof(struct at91_priv),
1314 1 << devtype_data->tx_shift);
1320 dev->netdev_ops = &at91_netdev_ops;
1322 dev->flags |= IFF_ECHO;
1324 priv = netdev_priv(dev);
1325 priv->can.clock.freq = clk_get_rate(clk);
1326 priv->can.bittiming_const = &at91_bittiming_const;
1327 priv->can.do_set_mode = at91_set_mode;
1328 priv->can.do_get_berr_counter = at91_get_berr_counter;
1329 priv->can.ctrlmode_supported = CAN_CTRLMODE_3_SAMPLES |
1330 CAN_CTRLMODE_LISTENONLY;
1331 priv->reg_base = addr;
1332 priv->devtype_data = *devtype_data;
1334 priv->pdata = dev_get_platdata(&pdev->dev);
1335 priv->mb0_id = 0x7ff;
1337 netif_napi_add(dev, &priv->napi, at91_poll, get_mb_rx_num(priv));
1339 if (at91_is_sam9263(priv))
1340 dev->sysfs_groups[0] = &at91_sysfs_attr_group;
1342 platform_set_drvdata(pdev, dev);
1343 SET_NETDEV_DEV(dev, &pdev->dev);
1345 err = register_candev(dev);
1347 dev_err(&pdev->dev, "registering netdev failed\n");
1351 devm_can_led_init(dev);
1353 dev_info(&pdev->dev, "device registered (reg_base=%p, irq=%d)\n",
1354 priv->reg_base, dev->irq);
1363 release_mem_region(res->start, resource_size(res));
1370 static int at91_can_remove(struct platform_device *pdev)
1372 struct net_device *dev = platform_get_drvdata(pdev);
1373 struct at91_priv *priv = netdev_priv(dev);
1374 struct resource *res;
1376 unregister_netdev(dev);
1378 iounmap(priv->reg_base);
1380 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1381 release_mem_region(res->start, resource_size(res));
1390 static const struct platform_device_id at91_can_id_table[] = {
1392 .name = "at91sam9x5_can",
1393 .driver_data = (kernel_ulong_t)&at91_at91sam9x5_data,
1396 .driver_data = (kernel_ulong_t)&at91_at91sam9263_data,
1401 MODULE_DEVICE_TABLE(platform, at91_can_id_table);
1403 static struct platform_driver at91_can_driver = {
1404 .probe = at91_can_probe,
1405 .remove = at91_can_remove,
1407 .name = KBUILD_MODNAME,
1408 .of_match_table = of_match_ptr(at91_can_dt_ids),
1410 .id_table = at91_can_id_table,
1413 module_platform_driver(at91_can_driver);
1416 MODULE_LICENSE("GPL v2");
1417 MODULE_DESCRIPTION(KBUILD_MODNAME " CAN netdevice driver");