1 // SPDX-License-Identifier: GPL-2.0-only
3 * at91_can.c - CAN network driver for AT91 SoC CAN controller
10 #include <linux/errno.h>
11 #include <linux/ethtool.h>
12 #include <linux/if_arp.h>
13 #include <linux/interrupt.h>
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/netdevice.h>
18 #include <linux/platform_device.h>
19 #include <linux/rtnetlink.h>
20 #include <linux/skbuff.h>
21 #include <linux/spinlock.h>
22 #include <linux/string.h>
23 #include <linux/types.h>
25 #include <linux/can/dev.h>
26 #include <linux/can/error.h>
28 #define AT91_MB_MASK(i) ((1 << (i)) - 1)
30 /* Common registers */
45 /* Mailbox registers (0 <= i <= 15) */
46 #define AT91_MMR(i) ((enum at91_reg)(0x200 + ((i) * 0x20)))
47 #define AT91_MAM(i) ((enum at91_reg)(0x204 + ((i) * 0x20)))
48 #define AT91_MID(i) ((enum at91_reg)(0x208 + ((i) * 0x20)))
49 #define AT91_MFID(i) ((enum at91_reg)(0x20C + ((i) * 0x20)))
50 #define AT91_MSR(i) ((enum at91_reg)(0x210 + ((i) * 0x20)))
51 #define AT91_MDL(i) ((enum at91_reg)(0x214 + ((i) * 0x20)))
52 #define AT91_MDH(i) ((enum at91_reg)(0x218 + ((i) * 0x20)))
53 #define AT91_MCR(i) ((enum at91_reg)(0x21C + ((i) * 0x20)))
56 #define AT91_MR_CANEN BIT(0)
57 #define AT91_MR_LPM BIT(1)
58 #define AT91_MR_ABM BIT(2)
59 #define AT91_MR_OVL BIT(3)
60 #define AT91_MR_TEOF BIT(4)
61 #define AT91_MR_TTM BIT(5)
62 #define AT91_MR_TIMFRZ BIT(6)
63 #define AT91_MR_DRPT BIT(7)
65 #define AT91_SR_RBSY BIT(29)
67 #define AT91_MMR_PRIO_SHIFT (16)
69 #define AT91_MID_MIDE BIT(29)
71 #define AT91_MSR_MRTR BIT(20)
72 #define AT91_MSR_MABT BIT(22)
73 #define AT91_MSR_MRDY BIT(23)
74 #define AT91_MSR_MMI BIT(24)
76 #define AT91_MCR_MRTR BIT(20)
77 #define AT91_MCR_MTCR BIT(23)
81 AT91_MB_MODE_DISABLED = 0,
83 AT91_MB_MODE_RX_OVRWR = 2,
85 AT91_MB_MODE_CONSUMER = 4,
86 AT91_MB_MODE_PRODUCER = 5,
89 /* Interrupt mask bits */
90 #define AT91_IRQ_ERRA BIT(16)
91 #define AT91_IRQ_WARN BIT(17)
92 #define AT91_IRQ_ERRP BIT(18)
93 #define AT91_IRQ_BOFF BIT(19)
94 #define AT91_IRQ_SLEEP BIT(20)
95 #define AT91_IRQ_WAKEUP BIT(21)
96 #define AT91_IRQ_TOVF BIT(22)
97 #define AT91_IRQ_TSTP BIT(23)
98 #define AT91_IRQ_CERR BIT(24)
99 #define AT91_IRQ_SERR BIT(25)
100 #define AT91_IRQ_AERR BIT(26)
101 #define AT91_IRQ_FERR BIT(27)
102 #define AT91_IRQ_BERR BIT(28)
104 #define AT91_IRQ_ERR_ALL (0x1fff0000)
105 #define AT91_IRQ_ERR_FRAME (AT91_IRQ_CERR | AT91_IRQ_SERR | \
106 AT91_IRQ_AERR | AT91_IRQ_FERR | AT91_IRQ_BERR)
107 #define AT91_IRQ_ERR_LINE (AT91_IRQ_ERRA | AT91_IRQ_WARN | \
108 AT91_IRQ_ERRP | AT91_IRQ_BOFF)
110 #define AT91_IRQ_ALL (0x1fffffff)
113 AT91_DEVTYPE_SAM9263,
117 struct at91_devtype_data {
118 unsigned int rx_first;
119 unsigned int rx_split;
120 unsigned int rx_last;
121 unsigned int tx_shift;
122 enum at91_devtype type;
126 struct can_priv can; /* must be the first member! */
127 struct napi_struct napi;
129 void __iomem *reg_base;
132 unsigned int tx_next;
133 unsigned int tx_echo;
134 unsigned int rx_next;
135 struct at91_devtype_data devtype_data;
138 struct at91_can_data *pdata;
143 static const struct at91_devtype_data at91_at91sam9263_data = {
148 .type = AT91_DEVTYPE_SAM9263,
151 static const struct at91_devtype_data at91_at91sam9x5_data = {
156 .type = AT91_DEVTYPE_SAM9X5,
159 static const struct can_bittiming_const at91_bittiming_const = {
160 .name = KBUILD_MODNAME,
171 #define AT91_IS(_model) \
172 static inline int __maybe_unused at91_is_sam##_model(const struct at91_priv *priv) \
174 return priv->devtype_data.type == AT91_DEVTYPE_SAM##_model; \
180 static inline unsigned int get_mb_rx_first(const struct at91_priv *priv)
182 return priv->devtype_data.rx_first;
185 static inline unsigned int get_mb_rx_last(const struct at91_priv *priv)
187 return priv->devtype_data.rx_last;
190 static inline unsigned int get_mb_rx_split(const struct at91_priv *priv)
192 return priv->devtype_data.rx_split;
195 static inline unsigned int get_mb_rx_num(const struct at91_priv *priv)
197 return get_mb_rx_last(priv) - get_mb_rx_first(priv) + 1;
200 static inline unsigned int get_mb_rx_low_last(const struct at91_priv *priv)
202 return get_mb_rx_split(priv) - 1;
205 static inline unsigned int get_mb_rx_low_mask(const struct at91_priv *priv)
207 return AT91_MB_MASK(get_mb_rx_split(priv)) &
208 ~AT91_MB_MASK(get_mb_rx_first(priv));
211 static inline unsigned int get_mb_tx_shift(const struct at91_priv *priv)
213 return priv->devtype_data.tx_shift;
216 static inline unsigned int get_mb_tx_num(const struct at91_priv *priv)
218 return 1 << get_mb_tx_shift(priv);
221 static inline unsigned int get_mb_tx_first(const struct at91_priv *priv)
223 return get_mb_rx_last(priv) + 1;
226 static inline unsigned int get_mb_tx_last(const struct at91_priv *priv)
228 return get_mb_tx_first(priv) + get_mb_tx_num(priv) - 1;
231 static inline unsigned int get_next_prio_shift(const struct at91_priv *priv)
233 return get_mb_tx_shift(priv);
236 static inline unsigned int get_next_prio_mask(const struct at91_priv *priv)
238 return 0xf << get_mb_tx_shift(priv);
241 static inline unsigned int get_next_mb_mask(const struct at91_priv *priv)
243 return AT91_MB_MASK(get_mb_tx_shift(priv));
246 static inline unsigned int get_next_mask(const struct at91_priv *priv)
248 return get_next_mb_mask(priv) | get_next_prio_mask(priv);
251 static inline unsigned int get_irq_mb_rx(const struct at91_priv *priv)
253 return AT91_MB_MASK(get_mb_rx_last(priv) + 1) &
254 ~AT91_MB_MASK(get_mb_rx_first(priv));
257 static inline unsigned int get_irq_mb_tx(const struct at91_priv *priv)
259 return AT91_MB_MASK(get_mb_tx_last(priv) + 1) &
260 ~AT91_MB_MASK(get_mb_tx_first(priv));
263 static inline unsigned int get_tx_next_mb(const struct at91_priv *priv)
265 return (priv->tx_next & get_next_mb_mask(priv)) + get_mb_tx_first(priv);
268 static inline unsigned int get_tx_next_prio(const struct at91_priv *priv)
270 return (priv->tx_next >> get_next_prio_shift(priv)) & 0xf;
273 static inline unsigned int get_tx_echo_mb(const struct at91_priv *priv)
275 return (priv->tx_echo & get_next_mb_mask(priv)) + get_mb_tx_first(priv);
278 static inline u32 at91_read(const struct at91_priv *priv, enum at91_reg reg)
280 return readl_relaxed(priv->reg_base + reg);
283 static inline void at91_write(const struct at91_priv *priv, enum at91_reg reg,
286 writel_relaxed(value, priv->reg_base + reg);
289 static inline void set_mb_mode_prio(const struct at91_priv *priv,
290 unsigned int mb, enum at91_mb_mode mode,
293 at91_write(priv, AT91_MMR(mb), (mode << 24) | (prio << 16));
296 static inline void set_mb_mode(const struct at91_priv *priv, unsigned int mb,
297 enum at91_mb_mode mode)
299 set_mb_mode_prio(priv, mb, mode, 0);
302 static inline u32 at91_can_id_to_reg_mid(canid_t can_id)
306 if (can_id & CAN_EFF_FLAG)
307 reg_mid = (can_id & CAN_EFF_MASK) | AT91_MID_MIDE;
309 reg_mid = (can_id & CAN_SFF_MASK) << 18;
314 static void at91_setup_mailboxes(struct net_device *dev)
316 struct at91_priv *priv = netdev_priv(dev);
320 /* Due to a chip bug (errata 50.2.6.3 & 50.3.5.3) the first
321 * mailbox is disabled. The next 11 mailboxes are used as a
322 * reception FIFO. The last mailbox is configured with
323 * overwrite option. The overwrite flag indicates a FIFO
326 reg_mid = at91_can_id_to_reg_mid(priv->mb0_id);
327 for (i = 0; i < get_mb_rx_first(priv); i++) {
328 set_mb_mode(priv, i, AT91_MB_MODE_DISABLED);
329 at91_write(priv, AT91_MID(i), reg_mid);
330 at91_write(priv, AT91_MCR(i), 0x0); /* clear dlc */
333 for (i = get_mb_rx_first(priv); i < get_mb_rx_last(priv); i++)
334 set_mb_mode(priv, i, AT91_MB_MODE_RX);
335 set_mb_mode(priv, get_mb_rx_last(priv), AT91_MB_MODE_RX_OVRWR);
337 /* reset acceptance mask and id register */
338 for (i = get_mb_rx_first(priv); i <= get_mb_rx_last(priv); i++) {
339 at91_write(priv, AT91_MAM(i), 0x0);
340 at91_write(priv, AT91_MID(i), AT91_MID_MIDE);
343 /* The last 4 mailboxes are used for transmitting. */
344 for (i = get_mb_tx_first(priv); i <= get_mb_tx_last(priv); i++)
345 set_mb_mode_prio(priv, i, AT91_MB_MODE_TX, 0);
347 /* Reset tx and rx helper pointers */
348 priv->tx_next = priv->tx_echo = 0;
349 priv->rx_next = get_mb_rx_first(priv);
352 static int at91_set_bittiming(struct net_device *dev)
354 const struct at91_priv *priv = netdev_priv(dev);
355 const struct can_bittiming *bt = &priv->can.bittiming;
358 reg_br = ((priv->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES) ? 1 << 24 : 0) |
359 ((bt->brp - 1) << 16) | ((bt->sjw - 1) << 12) |
360 ((bt->prop_seg - 1) << 8) | ((bt->phase_seg1 - 1) << 4) |
361 ((bt->phase_seg2 - 1) << 0);
363 netdev_info(dev, "writing AT91_BR: 0x%08x\n", reg_br);
365 at91_write(priv, AT91_BR, reg_br);
370 static int at91_get_berr_counter(const struct net_device *dev,
371 struct can_berr_counter *bec)
373 const struct at91_priv *priv = netdev_priv(dev);
374 u32 reg_ecr = at91_read(priv, AT91_ECR);
376 bec->rxerr = reg_ecr & 0xff;
377 bec->txerr = reg_ecr >> 16;
382 static void at91_chip_start(struct net_device *dev)
384 struct at91_priv *priv = netdev_priv(dev);
387 /* disable interrupts */
388 at91_write(priv, AT91_IDR, AT91_IRQ_ALL);
391 reg_mr = at91_read(priv, AT91_MR);
392 at91_write(priv, AT91_MR, reg_mr & ~AT91_MR_CANEN);
394 at91_set_bittiming(dev);
395 at91_setup_mailboxes(dev);
398 if (priv->can.ctrlmode & CAN_CTRLMODE_LISTENONLY)
399 reg_mr = AT91_MR_CANEN | AT91_MR_ABM;
401 reg_mr = AT91_MR_CANEN;
402 at91_write(priv, AT91_MR, reg_mr);
404 priv->can.state = CAN_STATE_ERROR_ACTIVE;
406 /* Enable interrupts */
407 reg_ier = get_irq_mb_rx(priv) | AT91_IRQ_ERRP | AT91_IRQ_ERR_FRAME;
408 at91_write(priv, AT91_IDR, AT91_IRQ_ALL);
409 at91_write(priv, AT91_IER, reg_ier);
412 static void at91_chip_stop(struct net_device *dev, enum can_state state)
414 struct at91_priv *priv = netdev_priv(dev);
417 /* disable interrupts */
418 at91_write(priv, AT91_IDR, AT91_IRQ_ALL);
420 reg_mr = at91_read(priv, AT91_MR);
421 at91_write(priv, AT91_MR, reg_mr & ~AT91_MR_CANEN);
423 priv->can.state = state;
426 /* theory of operation:
428 * According to the datasheet priority 0 is the highest priority, 15
429 * is the lowest. If two mailboxes have the same priority level the
430 * message of the mailbox with the lowest number is sent first.
432 * We use the first TX mailbox (AT91_MB_TX_FIRST) with prio 0, then
433 * the next mailbox with prio 0, and so on, until all mailboxes are
434 * used. Then we start from the beginning with mailbox
435 * AT91_MB_TX_FIRST, but with prio 1, mailbox AT91_MB_TX_FIRST + 1
436 * prio 1. When we reach the last mailbox with prio 15, we have to
437 * stop sending, waiting for all messages to be delivered, then start
438 * again with mailbox AT91_MB_TX_FIRST prio 0.
440 * We use the priv->tx_next as counter for the next transmission
441 * mailbox, but without the offset AT91_MB_TX_FIRST. The lower bits
442 * encode the mailbox number, the upper 4 bits the mailbox priority:
444 * priv->tx_next = (prio << get_next_prio_shift(priv)) |
445 * (mb - get_mb_tx_first(priv));
448 static netdev_tx_t at91_start_xmit(struct sk_buff *skb, struct net_device *dev)
450 struct at91_priv *priv = netdev_priv(dev);
451 struct can_frame *cf = (struct can_frame *)skb->data;
452 unsigned int mb, prio;
453 u32 reg_mid, reg_mcr;
455 if (can_dev_dropped_skb(dev, skb))
458 mb = get_tx_next_mb(priv);
459 prio = get_tx_next_prio(priv);
461 if (unlikely(!(at91_read(priv, AT91_MSR(mb)) & AT91_MSR_MRDY))) {
462 netif_stop_queue(dev);
464 netdev_err(dev, "BUG! TX buffer full when queue awake!\n");
465 return NETDEV_TX_BUSY;
467 reg_mid = at91_can_id_to_reg_mid(cf->can_id);
468 reg_mcr = ((cf->can_id & CAN_RTR_FLAG) ? AT91_MCR_MRTR : 0) |
469 (cf->len << 16) | AT91_MCR_MTCR;
471 /* disable MB while writing ID (see datasheet) */
472 set_mb_mode(priv, mb, AT91_MB_MODE_DISABLED);
473 at91_write(priv, AT91_MID(mb), reg_mid);
474 set_mb_mode_prio(priv, mb, AT91_MB_MODE_TX, prio);
476 at91_write(priv, AT91_MDL(mb), *(u32 *)(cf->data + 0));
477 at91_write(priv, AT91_MDH(mb), *(u32 *)(cf->data + 4));
479 /* This triggers transmission */
480 at91_write(priv, AT91_MCR(mb), reg_mcr);
482 /* _NOTE_: subtract AT91_MB_TX_FIRST offset from mb! */
483 can_put_echo_skb(skb, dev, mb - get_mb_tx_first(priv), 0);
485 /* we have to stop the queue and deliver all messages in case
486 * of a prio+mb counter wrap around. This is the case if
487 * tx_next buffer prio and mailbox equals 0.
489 * also stop the queue if next buffer is still in use
493 if (!(at91_read(priv, AT91_MSR(get_tx_next_mb(priv))) &
495 (priv->tx_next & get_next_mask(priv)) == 0)
496 netif_stop_queue(dev);
498 /* Enable interrupt for this mailbox */
499 at91_write(priv, AT91_IER, 1 << mb);
505 * at91_activate_rx_low - activate lower rx mailboxes
508 * Reenables the lower mailboxes for reception of new CAN messages
510 static inline void at91_activate_rx_low(const struct at91_priv *priv)
512 u32 mask = get_mb_rx_low_mask(priv);
514 at91_write(priv, AT91_TCR, mask);
518 * at91_activate_rx_mb - reactive single rx mailbox
520 * @mb: mailbox to reactivate
522 * Reenables given mailbox for reception of new CAN messages
524 static inline void at91_activate_rx_mb(const struct at91_priv *priv,
529 at91_write(priv, AT91_TCR, mask);
533 * at91_rx_overflow_err - send error frame due to rx overflow
536 static void at91_rx_overflow_err(struct net_device *dev)
538 struct net_device_stats *stats = &dev->stats;
540 struct can_frame *cf;
542 netdev_dbg(dev, "RX buffer overflow\n");
543 stats->rx_over_errors++;
546 skb = alloc_can_err_skb(dev, &cf);
550 cf->can_id |= CAN_ERR_CRTL;
551 cf->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
553 netif_receive_skb(skb);
557 * at91_read_mb - read CAN msg from mailbox (lowlevel impl)
559 * @mb: mailbox number to read from
560 * @cf: can frame where to store message
562 * Reads a CAN message from the given mailbox and stores data into
563 * given can frame. "mb" and "cf" must be valid.
565 static void at91_read_mb(struct net_device *dev, unsigned int mb,
566 struct can_frame *cf)
568 const struct at91_priv *priv = netdev_priv(dev);
569 u32 reg_msr, reg_mid;
571 reg_mid = at91_read(priv, AT91_MID(mb));
572 if (reg_mid & AT91_MID_MIDE)
573 cf->can_id = ((reg_mid >> 0) & CAN_EFF_MASK) | CAN_EFF_FLAG;
575 cf->can_id = (reg_mid >> 18) & CAN_SFF_MASK;
577 reg_msr = at91_read(priv, AT91_MSR(mb));
578 cf->len = can_cc_dlc2len((reg_msr >> 16) & 0xf);
580 if (reg_msr & AT91_MSR_MRTR) {
581 cf->can_id |= CAN_RTR_FLAG;
583 *(u32 *)(cf->data + 0) = at91_read(priv, AT91_MDL(mb));
584 *(u32 *)(cf->data + 4) = at91_read(priv, AT91_MDH(mb));
587 /* allow RX of extended frames */
588 at91_write(priv, AT91_MID(mb), AT91_MID_MIDE);
590 if (unlikely(mb == get_mb_rx_last(priv) && reg_msr & AT91_MSR_MMI))
591 at91_rx_overflow_err(dev);
595 * at91_read_msg - read CAN message from mailbox
597 * @mb: mail box to read from
599 * Reads a CAN message from given mailbox, and put into linux network
600 * RX queue, does all housekeeping chores (stats, ...)
602 static void at91_read_msg(struct net_device *dev, unsigned int mb)
604 struct net_device_stats *stats = &dev->stats;
605 struct can_frame *cf;
608 skb = alloc_can_skb(dev, &cf);
609 if (unlikely(!skb)) {
614 at91_read_mb(dev, mb, cf);
617 if (!(cf->can_id & CAN_RTR_FLAG))
618 stats->rx_bytes += cf->len;
620 netif_receive_skb(skb);
624 * at91_poll_rx - read multiple CAN messages from mailboxes
626 * @quota: max number of pkgs we're allowed to receive
628 * Theory of Operation:
630 * About 3/4 of the mailboxes (get_mb_rx_first()...get_mb_rx_last())
631 * on the chip are reserved for RX. We split them into 2 groups. The
632 * lower group ranges from get_mb_rx_first() to get_mb_rx_low_last().
634 * Like it or not, but the chip always saves a received CAN message
635 * into the first free mailbox it finds (starting with the
636 * lowest). This makes it very difficult to read the messages in the
637 * right order from the chip. This is how we work around that problem:
639 * The first message goes into mb nr. 1 and issues an interrupt. All
640 * rx ints are disabled in the interrupt handler and a napi poll is
641 * scheduled. We read the mailbox, but do _not_ re-enable the mb (to
642 * receive another message).
647 * +-+-+-+-+-+-+-+-++-+-+-+-+
648 * | |x|x|x|x|x|x|x|| | | | |
649 * +-+-+-+-+-+-+-+-++-+-+-+-+
650 * 0 0 0 0 0 0 0 0 0 0 1 1 \ mail
651 * 0 1 2 3 4 5 6 7 8 9 0 1 / box
655 * unused, due to chip bug
657 * The variable priv->rx_next points to the next mailbox to read a
658 * message from. As long we're in the lower mailboxes we just read the
659 * mailbox but not re-enable it.
661 * With completion of the last of the lower mailboxes, we re-enable the
662 * whole first group, but continue to look for filled mailboxes in the
663 * upper mailboxes. Imagine the second group like overflow mailboxes,
664 * which takes CAN messages if the lower goup is full. While in the
665 * upper group we re-enable the mailbox right after reading it. Giving
666 * the chip more room to store messages.
668 * After finishing we look again in the lower group if we've still
672 static int at91_poll_rx(struct net_device *dev, int quota)
674 struct at91_priv *priv = netdev_priv(dev);
675 u32 reg_sr = at91_read(priv, AT91_SR);
676 const unsigned long *addr = (unsigned long *)®_sr;
680 if (priv->rx_next > get_mb_rx_low_last(priv) &&
681 reg_sr & get_mb_rx_low_mask(priv))
683 "order of incoming frames cannot be guaranteed\n");
686 for (mb = find_next_bit(addr, get_mb_tx_first(priv), priv->rx_next);
687 mb < get_mb_tx_first(priv) && quota > 0;
688 reg_sr = at91_read(priv, AT91_SR),
689 mb = find_next_bit(addr, get_mb_tx_first(priv), ++priv->rx_next)) {
690 at91_read_msg(dev, mb);
692 /* reactivate mailboxes */
693 if (mb == get_mb_rx_low_last(priv))
694 /* all lower mailboxed, if just finished it */
695 at91_activate_rx_low(priv);
696 else if (mb > get_mb_rx_low_last(priv))
697 /* only the mailbox we read */
698 at91_activate_rx_mb(priv, mb);
704 /* upper group completed, look again in lower */
705 if (priv->rx_next > get_mb_rx_low_last(priv) &&
706 mb > get_mb_rx_last(priv)) {
707 priv->rx_next = get_mb_rx_first(priv);
715 static void at91_poll_err_frame(struct net_device *dev,
716 struct can_frame *cf, u32 reg_sr)
718 struct at91_priv *priv = netdev_priv(dev);
721 if (reg_sr & AT91_IRQ_CERR) {
722 netdev_dbg(dev, "CERR irq\n");
723 dev->stats.rx_errors++;
724 priv->can.can_stats.bus_error++;
725 cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
729 if (reg_sr & AT91_IRQ_SERR) {
730 netdev_dbg(dev, "SERR irq\n");
731 dev->stats.rx_errors++;
732 priv->can.can_stats.bus_error++;
733 cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
734 cf->data[2] |= CAN_ERR_PROT_STUFF;
737 /* Acknowledgement Error */
738 if (reg_sr & AT91_IRQ_AERR) {
739 netdev_dbg(dev, "AERR irq\n");
740 dev->stats.tx_errors++;
741 cf->can_id |= CAN_ERR_ACK;
745 if (reg_sr & AT91_IRQ_FERR) {
746 netdev_dbg(dev, "FERR irq\n");
747 dev->stats.rx_errors++;
748 priv->can.can_stats.bus_error++;
749 cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
750 cf->data[2] |= CAN_ERR_PROT_FORM;
754 if (reg_sr & AT91_IRQ_BERR) {
755 netdev_dbg(dev, "BERR irq\n");
756 dev->stats.tx_errors++;
757 priv->can.can_stats.bus_error++;
758 cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
759 cf->data[2] |= CAN_ERR_PROT_BIT;
763 static int at91_poll_err(struct net_device *dev, int quota, u32 reg_sr)
766 struct can_frame *cf;
771 skb = alloc_can_err_skb(dev, &cf);
775 at91_poll_err_frame(dev, cf, reg_sr);
777 netif_receive_skb(skb);
782 static int at91_poll(struct napi_struct *napi, int quota)
784 struct net_device *dev = napi->dev;
785 const struct at91_priv *priv = netdev_priv(dev);
786 u32 reg_sr = at91_read(priv, AT91_SR);
789 if (reg_sr & get_irq_mb_rx(priv))
790 work_done += at91_poll_rx(dev, quota - work_done);
792 /* The error bits are clear on read,
793 * so use saved value from irq handler.
795 reg_sr |= priv->reg_sr;
796 if (reg_sr & AT91_IRQ_ERR_FRAME)
797 work_done += at91_poll_err(dev, quota - work_done, reg_sr);
799 if (work_done < quota) {
800 /* enable IRQs for frame errors and all mailboxes >= rx_next */
801 u32 reg_ier = AT91_IRQ_ERR_FRAME;
803 reg_ier |= get_irq_mb_rx(priv) & ~AT91_MB_MASK(priv->rx_next);
805 napi_complete_done(napi, work_done);
806 at91_write(priv, AT91_IER, reg_ier);
812 /* theory of operation:
814 * priv->tx_echo holds the number of the oldest can_frame put for
815 * transmission into the hardware, but not yet ACKed by the CAN tx
818 * We iterate from priv->tx_echo to priv->tx_next and check if the
819 * packet has been transmitted, echo it back to the CAN framework. If
820 * we discover a not yet transmitted package, stop looking for more.
823 static void at91_irq_tx(struct net_device *dev, u32 reg_sr)
825 struct at91_priv *priv = netdev_priv(dev);
829 /* masking of reg_sr not needed, already done by at91_irq */
831 for (/* nix */; (priv->tx_next - priv->tx_echo) > 0; priv->tx_echo++) {
832 mb = get_tx_echo_mb(priv);
834 /* no event in mailbox? */
835 if (!(reg_sr & (1 << mb)))
838 /* Disable irq for this TX mailbox */
839 at91_write(priv, AT91_IDR, 1 << mb);
841 /* only echo if mailbox signals us a transfer
842 * complete (MSR_MRDY). Otherwise it's a tansfer
843 * abort. "can_bus_off()" takes care about the skbs
844 * parked in the echo queue.
846 reg_msr = at91_read(priv, AT91_MSR(mb));
847 if (likely(reg_msr & AT91_MSR_MRDY &&
848 ~reg_msr & AT91_MSR_MABT)) {
849 /* _NOTE_: subtract AT91_MB_TX_FIRST offset from mb! */
850 dev->stats.tx_bytes +=
851 can_get_echo_skb(dev,
852 mb - get_mb_tx_first(priv),
854 dev->stats.tx_packets++;
858 /* restart queue if we don't have a wrap around but restart if
859 * we get a TX int for the last can frame directly before a
862 if ((priv->tx_next & get_next_mask(priv)) != 0 ||
863 (priv->tx_echo & get_next_mask(priv)) == 0)
864 netif_wake_queue(dev);
867 static void at91_irq_err_state(struct net_device *dev,
868 struct can_frame *cf, enum can_state new_state)
870 struct at91_priv *priv = netdev_priv(dev);
871 u32 reg_idr = 0, reg_ier = 0;
872 struct can_berr_counter bec;
874 at91_get_berr_counter(dev, &bec);
876 switch (priv->can.state) {
877 case CAN_STATE_ERROR_ACTIVE:
878 /* from: ERROR_ACTIVE
879 * to : ERROR_WARNING, ERROR_PASSIVE, BUS_OFF
880 * => : there was a warning int
882 if (new_state >= CAN_STATE_ERROR_WARNING &&
883 new_state <= CAN_STATE_BUS_OFF) {
884 netdev_dbg(dev, "Error Warning IRQ\n");
885 priv->can.can_stats.error_warning++;
887 cf->can_id |= CAN_ERR_CRTL;
888 cf->data[1] = (bec.txerr > bec.rxerr) ?
889 CAN_ERR_CRTL_TX_WARNING :
890 CAN_ERR_CRTL_RX_WARNING;
893 case CAN_STATE_ERROR_WARNING:
894 /* from: ERROR_ACTIVE, ERROR_WARNING
895 * to : ERROR_PASSIVE, BUS_OFF
896 * => : error passive int
898 if (new_state >= CAN_STATE_ERROR_PASSIVE &&
899 new_state <= CAN_STATE_BUS_OFF) {
900 netdev_dbg(dev, "Error Passive IRQ\n");
901 priv->can.can_stats.error_passive++;
903 cf->can_id |= CAN_ERR_CRTL;
904 cf->data[1] = (bec.txerr > bec.rxerr) ?
905 CAN_ERR_CRTL_TX_PASSIVE :
906 CAN_ERR_CRTL_RX_PASSIVE;
909 case CAN_STATE_BUS_OFF:
911 * to : ERROR_ACTIVE, ERROR_WARNING, ERROR_PASSIVE
913 if (new_state <= CAN_STATE_ERROR_PASSIVE) {
914 cf->can_id |= CAN_ERR_RESTARTED;
916 netdev_dbg(dev, "restarted\n");
917 priv->can.can_stats.restarts++;
919 netif_carrier_on(dev);
920 netif_wake_queue(dev);
927 /* process state changes depending on the new state */
929 case CAN_STATE_ERROR_ACTIVE:
930 /* actually we want to enable AT91_IRQ_WARN here, but
931 * it screws up the system under certain
932 * circumstances. so just enable AT91_IRQ_ERRP, thus
935 netdev_dbg(dev, "Error Active\n");
936 cf->can_id |= CAN_ERR_PROT;
937 cf->data[2] = CAN_ERR_PROT_ACTIVE;
939 case CAN_STATE_ERROR_WARNING:
940 reg_idr = AT91_IRQ_ERRA | AT91_IRQ_WARN | AT91_IRQ_BOFF;
941 reg_ier = AT91_IRQ_ERRP;
943 case CAN_STATE_ERROR_PASSIVE:
944 reg_idr = AT91_IRQ_ERRA | AT91_IRQ_WARN | AT91_IRQ_ERRP;
945 reg_ier = AT91_IRQ_BOFF;
947 case CAN_STATE_BUS_OFF:
948 reg_idr = AT91_IRQ_ERRA | AT91_IRQ_ERRP |
949 AT91_IRQ_WARN | AT91_IRQ_BOFF;
952 cf->can_id |= CAN_ERR_BUSOFF;
954 netdev_dbg(dev, "bus-off\n");
955 netif_carrier_off(dev);
956 priv->can.can_stats.bus_off++;
958 /* turn off chip, if restart is disabled */
959 if (!priv->can.restart_ms) {
960 at91_chip_stop(dev, CAN_STATE_BUS_OFF);
968 at91_write(priv, AT91_IDR, reg_idr);
969 at91_write(priv, AT91_IER, reg_ier);
972 static int at91_get_state_by_bec(const struct net_device *dev,
973 enum can_state *state)
975 struct can_berr_counter bec;
978 err = at91_get_berr_counter(dev, &bec);
982 if (bec.txerr < 96 && bec.rxerr < 96)
983 *state = CAN_STATE_ERROR_ACTIVE;
984 else if (bec.txerr < 128 && bec.rxerr < 128)
985 *state = CAN_STATE_ERROR_WARNING;
986 else if (bec.txerr < 256 && bec.rxerr < 256)
987 *state = CAN_STATE_ERROR_PASSIVE;
989 *state = CAN_STATE_BUS_OFF;
994 static void at91_irq_err(struct net_device *dev)
996 struct at91_priv *priv = netdev_priv(dev);
998 struct can_frame *cf;
999 enum can_state new_state;
1003 if (at91_is_sam9263(priv)) {
1004 reg_sr = at91_read(priv, AT91_SR);
1006 /* we need to look at the unmasked reg_sr */
1007 if (unlikely(reg_sr & AT91_IRQ_BOFF)) {
1008 new_state = CAN_STATE_BUS_OFF;
1009 } else if (unlikely(reg_sr & AT91_IRQ_ERRP)) {
1010 new_state = CAN_STATE_ERROR_PASSIVE;
1011 } else if (unlikely(reg_sr & AT91_IRQ_WARN)) {
1012 new_state = CAN_STATE_ERROR_WARNING;
1013 } else if (likely(reg_sr & AT91_IRQ_ERRA)) {
1014 new_state = CAN_STATE_ERROR_ACTIVE;
1016 netdev_err(dev, "BUG! hardware in undefined state\n");
1020 err = at91_get_state_by_bec(dev, &new_state);
1025 /* state hasn't changed */
1026 if (likely(new_state == priv->can.state))
1029 skb = alloc_can_err_skb(dev, &cf);
1033 at91_irq_err_state(dev, cf, new_state);
1037 priv->can.state = new_state;
1040 /* interrupt handler
1042 static irqreturn_t at91_irq(int irq, void *dev_id)
1044 struct net_device *dev = dev_id;
1045 struct at91_priv *priv = netdev_priv(dev);
1046 irqreturn_t handled = IRQ_NONE;
1047 u32 reg_sr, reg_imr;
1049 reg_sr = at91_read(priv, AT91_SR);
1050 reg_imr = at91_read(priv, AT91_IMR);
1052 /* Ignore masked interrupts */
1057 handled = IRQ_HANDLED;
1059 /* Receive or error interrupt? -> napi */
1060 if (reg_sr & (get_irq_mb_rx(priv) | AT91_IRQ_ERR_FRAME)) {
1061 /* The error bits are clear on read,
1062 * save for later use.
1064 priv->reg_sr = reg_sr;
1065 at91_write(priv, AT91_IDR,
1066 get_irq_mb_rx(priv) | AT91_IRQ_ERR_FRAME);
1067 napi_schedule(&priv->napi);
1070 /* Transmission complete interrupt */
1071 if (reg_sr & get_irq_mb_tx(priv))
1072 at91_irq_tx(dev, reg_sr);
1080 static int at91_open(struct net_device *dev)
1082 struct at91_priv *priv = netdev_priv(dev);
1085 err = clk_prepare_enable(priv->clk);
1089 /* check or determine and set bittime */
1090 err = open_candev(dev);
1094 /* register interrupt handler */
1095 if (request_irq(dev->irq, at91_irq, IRQF_SHARED,
1101 /* start chip and queuing */
1102 at91_chip_start(dev);
1103 napi_enable(&priv->napi);
1104 netif_start_queue(dev);
1111 clk_disable_unprepare(priv->clk);
1116 /* stop CAN bus activity
1118 static int at91_close(struct net_device *dev)
1120 struct at91_priv *priv = netdev_priv(dev);
1122 netif_stop_queue(dev);
1123 napi_disable(&priv->napi);
1124 at91_chip_stop(dev, CAN_STATE_STOPPED);
1126 free_irq(dev->irq, dev);
1127 clk_disable_unprepare(priv->clk);
1134 static int at91_set_mode(struct net_device *dev, enum can_mode mode)
1137 case CAN_MODE_START:
1138 at91_chip_start(dev);
1139 netif_wake_queue(dev);
1149 static const struct net_device_ops at91_netdev_ops = {
1150 .ndo_open = at91_open,
1151 .ndo_stop = at91_close,
1152 .ndo_start_xmit = at91_start_xmit,
1153 .ndo_change_mtu = can_change_mtu,
1156 static const struct ethtool_ops at91_ethtool_ops = {
1157 .get_ts_info = ethtool_op_get_ts_info,
1160 static ssize_t mb0_id_show(struct device *dev,
1161 struct device_attribute *attr, char *buf)
1163 struct at91_priv *priv = netdev_priv(to_net_dev(dev));
1165 if (priv->mb0_id & CAN_EFF_FLAG)
1166 return sysfs_emit(buf, "0x%08x\n", priv->mb0_id);
1168 return sysfs_emit(buf, "0x%03x\n", priv->mb0_id);
1171 static ssize_t mb0_id_store(struct device *dev,
1172 struct device_attribute *attr,
1173 const char *buf, size_t count)
1175 struct net_device *ndev = to_net_dev(dev);
1176 struct at91_priv *priv = netdev_priv(ndev);
1177 unsigned long can_id;
1183 if (ndev->flags & IFF_UP) {
1188 err = kstrtoul(buf, 0, &can_id);
1194 if (can_id & CAN_EFF_FLAG)
1195 can_id &= CAN_EFF_MASK | CAN_EFF_FLAG;
1197 can_id &= CAN_SFF_MASK;
1199 priv->mb0_id = can_id;
1207 static DEVICE_ATTR_RW(mb0_id);
1209 static struct attribute *at91_sysfs_attrs[] = {
1210 &dev_attr_mb0_id.attr,
1214 static const struct attribute_group at91_sysfs_attr_group = {
1215 .attrs = at91_sysfs_attrs,
1218 #if defined(CONFIG_OF)
1219 static const struct of_device_id at91_can_dt_ids[] = {
1221 .compatible = "atmel,at91sam9x5-can",
1222 .data = &at91_at91sam9x5_data,
1224 .compatible = "atmel,at91sam9263-can",
1225 .data = &at91_at91sam9263_data,
1230 MODULE_DEVICE_TABLE(of, at91_can_dt_ids);
1233 static const struct at91_devtype_data *at91_can_get_driver_data(struct platform_device *pdev)
1235 if (pdev->dev.of_node) {
1236 const struct of_device_id *match;
1238 match = of_match_node(at91_can_dt_ids, pdev->dev.of_node);
1240 dev_err(&pdev->dev, "no matching node found in dtb\n");
1243 return (const struct at91_devtype_data *)match->data;
1245 return (const struct at91_devtype_data *)
1246 platform_get_device_id(pdev)->driver_data;
1249 static int at91_can_probe(struct platform_device *pdev)
1251 const struct at91_devtype_data *devtype_data;
1252 struct net_device *dev;
1253 struct at91_priv *priv;
1254 struct resource *res;
1259 devtype_data = at91_can_get_driver_data(pdev);
1260 if (!devtype_data) {
1261 dev_err(&pdev->dev, "no driver data\n");
1266 clk = clk_get(&pdev->dev, "can_clk");
1268 dev_err(&pdev->dev, "no clock defined\n");
1273 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1274 irq = platform_get_irq(pdev, 0);
1275 if (!res || irq <= 0) {
1280 if (!request_mem_region(res->start,
1287 addr = ioremap(res->start, resource_size(res));
1293 dev = alloc_candev(sizeof(struct at91_priv),
1294 1 << devtype_data->tx_shift);
1300 dev->netdev_ops = &at91_netdev_ops;
1301 dev->ethtool_ops = &at91_ethtool_ops;
1303 dev->flags |= IFF_ECHO;
1305 priv = netdev_priv(dev);
1306 priv->can.clock.freq = clk_get_rate(clk);
1307 priv->can.bittiming_const = &at91_bittiming_const;
1308 priv->can.do_set_mode = at91_set_mode;
1309 priv->can.do_get_berr_counter = at91_get_berr_counter;
1310 priv->can.ctrlmode_supported = CAN_CTRLMODE_3_SAMPLES |
1311 CAN_CTRLMODE_LISTENONLY;
1312 priv->reg_base = addr;
1313 priv->devtype_data = *devtype_data;
1315 priv->pdata = dev_get_platdata(&pdev->dev);
1316 priv->mb0_id = 0x7ff;
1318 netif_napi_add_weight(dev, &priv->napi, at91_poll, get_mb_rx_num(priv));
1320 if (at91_is_sam9263(priv))
1321 dev->sysfs_groups[0] = &at91_sysfs_attr_group;
1323 platform_set_drvdata(pdev, dev);
1324 SET_NETDEV_DEV(dev, &pdev->dev);
1326 err = register_candev(dev);
1328 dev_err(&pdev->dev, "registering netdev failed\n");
1332 dev_info(&pdev->dev, "device registered (reg_base=%p, irq=%d)\n",
1333 priv->reg_base, dev->irq);
1342 release_mem_region(res->start, resource_size(res));
1349 static void at91_can_remove(struct platform_device *pdev)
1351 struct net_device *dev = platform_get_drvdata(pdev);
1352 struct at91_priv *priv = netdev_priv(dev);
1353 struct resource *res;
1355 unregister_netdev(dev);
1357 iounmap(priv->reg_base);
1359 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1360 release_mem_region(res->start, resource_size(res));
1367 static const struct platform_device_id at91_can_id_table[] = {
1369 .name = "at91sam9x5_can",
1370 .driver_data = (kernel_ulong_t)&at91_at91sam9x5_data,
1373 .driver_data = (kernel_ulong_t)&at91_at91sam9263_data,
1378 MODULE_DEVICE_TABLE(platform, at91_can_id_table);
1380 static struct platform_driver at91_can_driver = {
1381 .probe = at91_can_probe,
1382 .remove_new = at91_can_remove,
1384 .name = KBUILD_MODNAME,
1385 .of_match_table = of_match_ptr(at91_can_dt_ids),
1387 .id_table = at91_can_id_table,
1390 module_platform_driver(at91_can_driver);
1393 MODULE_LICENSE("GPL v2");
1394 MODULE_DESCRIPTION(KBUILD_MODNAME " CAN netdevice driver");