2 * TI HECC (CAN) device driver
4 * This driver supports TI's HECC (High End CAN Controller module) and the
5 * specs for the same is available at <http://www.ti.com>
7 * Copyright (C) 2009 Texas Instruments Incorporated - http://www.ti.com/
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License as
11 * published by the Free Software Foundation version 2.
13 * This program is distributed as is WITHOUT ANY WARRANTY of any
14 * kind, whether express or implied; without even the implied warranty
15 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
21 * Your platform definitions should specify module ram offsets and interrupt
22 * number to use as follows:
24 * static struct ti_hecc_platform_data am3517_evm_hecc_pdata = {
25 * .scc_hecc_offset = 0,
26 * .scc_ram_offset = 0x3000,
27 * .hecc_ram_offset = 0x3000,
28 * .mbx_offset = 0x2000,
31 * .transceiver_switch = hecc_phy_control,
34 * Please see include/linux/can/platform/ti_hecc.h for description of
39 #include <linux/module.h>
40 #include <linux/init.h>
41 #include <linux/kernel.h>
42 #include <linux/types.h>
43 #include <linux/interrupt.h>
44 #include <linux/errno.h>
45 #include <linux/netdevice.h>
46 #include <linux/skbuff.h>
47 #include <linux/platform_device.h>
48 #include <linux/clk.h>
51 #include <linux/can/dev.h>
52 #include <linux/can/error.h>
53 #include <linux/can/led.h>
54 #include <linux/can/platform/ti_hecc.h>
56 #define DRV_NAME "ti_hecc"
57 #define HECC_MODULE_VERSION "0.7"
58 MODULE_VERSION(HECC_MODULE_VERSION);
59 #define DRV_DESC "TI High End CAN Controller Driver " HECC_MODULE_VERSION
61 /* TX / RX Mailbox Configuration */
62 #define HECC_MAX_MAILBOXES 32 /* hardware mailboxes - do not change */
63 #define MAX_TX_PRIO 0x3F /* hardware value - do not change */
66 * Important Note: TX mailbox configuration
67 * TX mailboxes should be restricted to the number of SKB buffers to avoid
68 * maintaining SKB buffers separately. TX mailboxes should be a power of 2
69 * for the mailbox logic to work. Top mailbox numbers are reserved for RX
70 * and lower mailboxes for TX.
72 * HECC_MAX_TX_MBOX HECC_MB_TX_SHIFT
77 #define HECC_MB_TX_SHIFT 2 /* as per table above */
78 #define HECC_MAX_TX_MBOX BIT(HECC_MB_TX_SHIFT)
80 #define HECC_TX_PRIO_SHIFT (HECC_MB_TX_SHIFT)
81 #define HECC_TX_PRIO_MASK (MAX_TX_PRIO << HECC_MB_TX_SHIFT)
82 #define HECC_TX_MB_MASK (HECC_MAX_TX_MBOX - 1)
83 #define HECC_TX_MASK ((HECC_MAX_TX_MBOX - 1) | HECC_TX_PRIO_MASK)
84 #define HECC_TX_MBOX_MASK (~(BIT(HECC_MAX_TX_MBOX) - 1))
85 #define HECC_DEF_NAPI_WEIGHT HECC_MAX_RX_MBOX
88 * Important Note: RX mailbox configuration
89 * RX mailboxes are further logically split into two - main and buffer
90 * mailboxes. The goal is to get all packets into main mailboxes as
91 * driven by mailbox number and receive priority (higher to lower) and
92 * buffer mailboxes are used to receive pkts while main mailboxes are being
93 * processed. This ensures in-order packet reception.
95 * Here are the recommended values for buffer mailbox. Note that RX mailboxes
96 * start after TX mailboxes:
98 * HECC_MAX_RX_MBOX HECC_RX_BUFFER_MBOX No of buffer mailboxes
103 #define HECC_MAX_RX_MBOX (HECC_MAX_MAILBOXES - HECC_MAX_TX_MBOX)
104 #define HECC_RX_BUFFER_MBOX 12 /* as per table above */
105 #define HECC_RX_FIRST_MBOX (HECC_MAX_MAILBOXES - 1)
106 #define HECC_RX_HIGH_MBOX_MASK (~(BIT(HECC_RX_BUFFER_MBOX) - 1))
108 /* TI HECC module registers */
109 #define HECC_CANME 0x0 /* Mailbox enable */
110 #define HECC_CANMD 0x4 /* Mailbox direction */
111 #define HECC_CANTRS 0x8 /* Transmit request set */
112 #define HECC_CANTRR 0xC /* Transmit request */
113 #define HECC_CANTA 0x10 /* Transmission acknowledge */
114 #define HECC_CANAA 0x14 /* Abort acknowledge */
115 #define HECC_CANRMP 0x18 /* Receive message pending */
116 #define HECC_CANRML 0x1C /* Remote message lost */
117 #define HECC_CANRFP 0x20 /* Remote frame pending */
118 #define HECC_CANGAM 0x24 /* SECC only:Global acceptance mask */
119 #define HECC_CANMC 0x28 /* Master control */
120 #define HECC_CANBTC 0x2C /* Bit timing configuration */
121 #define HECC_CANES 0x30 /* Error and status */
122 #define HECC_CANTEC 0x34 /* Transmit error counter */
123 #define HECC_CANREC 0x38 /* Receive error counter */
124 #define HECC_CANGIF0 0x3C /* Global interrupt flag 0 */
125 #define HECC_CANGIM 0x40 /* Global interrupt mask */
126 #define HECC_CANGIF1 0x44 /* Global interrupt flag 1 */
127 #define HECC_CANMIM 0x48 /* Mailbox interrupt mask */
128 #define HECC_CANMIL 0x4C /* Mailbox interrupt level */
129 #define HECC_CANOPC 0x50 /* Overwrite protection control */
130 #define HECC_CANTIOC 0x54 /* Transmit I/O control */
131 #define HECC_CANRIOC 0x58 /* Receive I/O control */
132 #define HECC_CANLNT 0x5C /* HECC only: Local network time */
133 #define HECC_CANTOC 0x60 /* HECC only: Time-out control */
134 #define HECC_CANTOS 0x64 /* HECC only: Time-out status */
135 #define HECC_CANTIOCE 0x68 /* SCC only:Enhanced TX I/O control */
136 #define HECC_CANRIOCE 0x6C /* SCC only:Enhanced RX I/O control */
138 /* Mailbox registers */
139 #define HECC_CANMID 0x0
140 #define HECC_CANMCF 0x4
141 #define HECC_CANMDL 0x8
142 #define HECC_CANMDH 0xC
144 #define HECC_SET_REG 0xFFFFFFFF
145 #define HECC_CANID_MASK 0x3FF /* 18 bits mask for extended id's */
146 #define HECC_CCE_WAIT_COUNT 100 /* Wait for ~1 sec for CCE bit */
148 #define HECC_CANMC_SCM BIT(13) /* SCC compat mode */
149 #define HECC_CANMC_CCR BIT(12) /* Change config request */
150 #define HECC_CANMC_PDR BIT(11) /* Local Power down - for sleep mode */
151 #define HECC_CANMC_ABO BIT(7) /* Auto Bus On */
152 #define HECC_CANMC_STM BIT(6) /* Self test mode - loopback */
153 #define HECC_CANMC_SRES BIT(5) /* Software reset */
155 #define HECC_CANTIOC_EN BIT(3) /* Enable CAN TX I/O pin */
156 #define HECC_CANRIOC_EN BIT(3) /* Enable CAN RX I/O pin */
158 #define HECC_CANMID_IDE BIT(31) /* Extended frame format */
159 #define HECC_CANMID_AME BIT(30) /* Acceptance mask enable */
160 #define HECC_CANMID_AAM BIT(29) /* Auto answer mode */
162 #define HECC_CANES_FE BIT(24) /* form error */
163 #define HECC_CANES_BE BIT(23) /* bit error */
164 #define HECC_CANES_SA1 BIT(22) /* stuck at dominant error */
165 #define HECC_CANES_CRCE BIT(21) /* CRC error */
166 #define HECC_CANES_SE BIT(20) /* stuff bit error */
167 #define HECC_CANES_ACKE BIT(19) /* ack error */
168 #define HECC_CANES_BO BIT(18) /* Bus off status */
169 #define HECC_CANES_EP BIT(17) /* Error passive status */
170 #define HECC_CANES_EW BIT(16) /* Error warning status */
171 #define HECC_CANES_SMA BIT(5) /* suspend mode ack */
172 #define HECC_CANES_CCE BIT(4) /* Change config enabled */
173 #define HECC_CANES_PDA BIT(3) /* Power down mode ack */
175 #define HECC_CANBTC_SAM BIT(7) /* sample points */
177 #define HECC_BUS_ERROR (HECC_CANES_FE | HECC_CANES_BE |\
178 HECC_CANES_CRCE | HECC_CANES_SE |\
181 #define HECC_CANMCF_RTR BIT(4) /* Remote transmit request */
183 #define HECC_CANGIF_MAIF BIT(17) /* Message alarm interrupt */
184 #define HECC_CANGIF_TCOIF BIT(16) /* Timer counter overflow int */
185 #define HECC_CANGIF_GMIF BIT(15) /* Global mailbox interrupt */
186 #define HECC_CANGIF_AAIF BIT(14) /* Abort ack interrupt */
187 #define HECC_CANGIF_WDIF BIT(13) /* Write denied interrupt */
188 #define HECC_CANGIF_WUIF BIT(12) /* Wake up interrupt */
189 #define HECC_CANGIF_RMLIF BIT(11) /* Receive message lost interrupt */
190 #define HECC_CANGIF_BOIF BIT(10) /* Bus off interrupt */
191 #define HECC_CANGIF_EPIF BIT(9) /* Error passive interrupt */
192 #define HECC_CANGIF_WLIF BIT(8) /* Warning level interrupt */
193 #define HECC_CANGIF_MBOX_MASK 0x1F /* Mailbox number mask */
194 #define HECC_CANGIM_I1EN BIT(1) /* Int line 1 enable */
195 #define HECC_CANGIM_I0EN BIT(0) /* Int line 0 enable */
196 #define HECC_CANGIM_DEF_MASK 0x700 /* only busoff/warning/passive */
197 #define HECC_CANGIM_SIL BIT(2) /* system interrupts to int line 1 */
199 /* CAN Bittiming constants as per HECC specs */
200 static const struct can_bittiming_const ti_hecc_bittiming_const = {
212 struct ti_hecc_priv {
213 struct can_priv can; /* MUST be first member/field */
214 struct napi_struct napi;
215 struct net_device *ndev;
222 spinlock_t mbx_lock; /* CANME register needs protection */
226 void (*transceiver_switch)(int);
229 static inline int get_tx_head_mb(struct ti_hecc_priv *priv)
231 return priv->tx_head & HECC_TX_MB_MASK;
234 static inline int get_tx_tail_mb(struct ti_hecc_priv *priv)
236 return priv->tx_tail & HECC_TX_MB_MASK;
239 static inline int get_tx_head_prio(struct ti_hecc_priv *priv)
241 return (priv->tx_head >> HECC_TX_PRIO_SHIFT) & MAX_TX_PRIO;
244 static inline void hecc_write_lam(struct ti_hecc_priv *priv, u32 mbxno, u32 val)
246 __raw_writel(val, priv->base + priv->hecc_ram_offset + mbxno * 4);
249 static inline void hecc_write_mbx(struct ti_hecc_priv *priv, u32 mbxno,
252 __raw_writel(val, priv->base + priv->mbx_offset + mbxno * 0x10 +
256 static inline u32 hecc_read_mbx(struct ti_hecc_priv *priv, u32 mbxno, u32 reg)
258 return __raw_readl(priv->base + priv->mbx_offset + mbxno * 0x10 +
262 static inline void hecc_write(struct ti_hecc_priv *priv, u32 reg, u32 val)
264 __raw_writel(val, priv->base + reg);
267 static inline u32 hecc_read(struct ti_hecc_priv *priv, int reg)
269 return __raw_readl(priv->base + reg);
272 static inline void hecc_set_bit(struct ti_hecc_priv *priv, int reg,
275 hecc_write(priv, reg, hecc_read(priv, reg) | bit_mask);
278 static inline void hecc_clear_bit(struct ti_hecc_priv *priv, int reg,
281 hecc_write(priv, reg, hecc_read(priv, reg) & ~bit_mask);
284 static inline u32 hecc_get_bit(struct ti_hecc_priv *priv, int reg, u32 bit_mask)
286 return (hecc_read(priv, reg) & bit_mask) ? 1 : 0;
289 static int ti_hecc_set_btc(struct ti_hecc_priv *priv)
291 struct can_bittiming *bit_timing = &priv->can.bittiming;
294 can_btc = (bit_timing->phase_seg2 - 1) & 0x7;
295 can_btc |= ((bit_timing->phase_seg1 + bit_timing->prop_seg - 1)
297 if (priv->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES) {
298 if (bit_timing->brp > 4)
299 can_btc |= HECC_CANBTC_SAM;
301 netdev_warn(priv->ndev, "WARN: Triple"
302 "sampling not set due to h/w limitations");
304 can_btc |= ((bit_timing->sjw - 1) & 0x3) << 8;
305 can_btc |= ((bit_timing->brp - 1) & 0xFF) << 16;
307 /* ERM being set to 0 by default meaning resync at falling edge */
309 hecc_write(priv, HECC_CANBTC, can_btc);
310 netdev_info(priv->ndev, "setting CANBTC=%#x\n", can_btc);
315 static void ti_hecc_transceiver_switch(const struct ti_hecc_priv *priv,
318 if (priv->transceiver_switch)
319 priv->transceiver_switch(on);
322 static void ti_hecc_reset(struct net_device *ndev)
325 struct ti_hecc_priv *priv = netdev_priv(ndev);
327 netdev_dbg(ndev, "resetting hecc ...\n");
328 hecc_set_bit(priv, HECC_CANMC, HECC_CANMC_SRES);
330 /* Set change control request and wait till enabled */
331 hecc_set_bit(priv, HECC_CANMC, HECC_CANMC_CCR);
334 * INFO: It has been observed that at times CCE bit may not be
335 * set and hw seems to be ok even if this bit is not set so
336 * timing out with a timing of 1ms to respect the specs
338 cnt = HECC_CCE_WAIT_COUNT;
339 while (!hecc_get_bit(priv, HECC_CANES, HECC_CANES_CCE) && cnt != 0) {
345 * Note: On HECC, BTC can be programmed only in initialization mode, so
346 * it is expected that the can bittiming parameters are set via ip
347 * utility before the device is opened
349 ti_hecc_set_btc(priv);
351 /* Clear CCR (and CANMC register) and wait for CCE = 0 enable */
352 hecc_write(priv, HECC_CANMC, 0);
355 * INFO: CAN net stack handles bus off and hence disabling auto-bus-on
356 * hecc_set_bit(priv, HECC_CANMC, HECC_CANMC_ABO);
360 * INFO: It has been observed that at times CCE bit may not be
361 * set and hw seems to be ok even if this bit is not set so
363 cnt = HECC_CCE_WAIT_COUNT;
364 while (hecc_get_bit(priv, HECC_CANES, HECC_CANES_CCE) && cnt != 0) {
369 /* Enable TX and RX I/O Control pins */
370 hecc_write(priv, HECC_CANTIOC, HECC_CANTIOC_EN);
371 hecc_write(priv, HECC_CANRIOC, HECC_CANRIOC_EN);
373 /* Clear registers for clean operation */
374 hecc_write(priv, HECC_CANTA, HECC_SET_REG);
375 hecc_write(priv, HECC_CANRMP, HECC_SET_REG);
376 hecc_write(priv, HECC_CANGIF0, HECC_SET_REG);
377 hecc_write(priv, HECC_CANGIF1, HECC_SET_REG);
378 hecc_write(priv, HECC_CANME, 0);
379 hecc_write(priv, HECC_CANMD, 0);
381 /* SCC compat mode NOT supported (and not needed too) */
382 hecc_set_bit(priv, HECC_CANMC, HECC_CANMC_SCM);
385 static void ti_hecc_start(struct net_device *ndev)
387 struct ti_hecc_priv *priv = netdev_priv(ndev);
388 u32 cnt, mbxno, mbx_mask;
390 /* put HECC in initialization mode and set btc */
393 priv->tx_head = priv->tx_tail = HECC_TX_MASK;
394 priv->rx_next = HECC_RX_FIRST_MBOX;
396 /* Enable local and global acceptance mask registers */
397 hecc_write(priv, HECC_CANGAM, HECC_SET_REG);
399 /* Prepare configured mailboxes to receive messages */
400 for (cnt = 0; cnt < HECC_MAX_RX_MBOX; cnt++) {
401 mbxno = HECC_MAX_MAILBOXES - 1 - cnt;
402 mbx_mask = BIT(mbxno);
403 hecc_clear_bit(priv, HECC_CANME, mbx_mask);
404 hecc_write_mbx(priv, mbxno, HECC_CANMID, HECC_CANMID_AME);
405 hecc_write_lam(priv, mbxno, HECC_SET_REG);
406 hecc_set_bit(priv, HECC_CANMD, mbx_mask);
407 hecc_set_bit(priv, HECC_CANME, mbx_mask);
408 hecc_set_bit(priv, HECC_CANMIM, mbx_mask);
411 /* Prevent message over-write & Enable interrupts */
412 hecc_write(priv, HECC_CANOPC, HECC_SET_REG);
413 if (priv->int_line) {
414 hecc_write(priv, HECC_CANMIL, HECC_SET_REG);
415 hecc_write(priv, HECC_CANGIM, HECC_CANGIM_DEF_MASK |
416 HECC_CANGIM_I1EN | HECC_CANGIM_SIL);
418 hecc_write(priv, HECC_CANMIL, 0);
419 hecc_write(priv, HECC_CANGIM,
420 HECC_CANGIM_DEF_MASK | HECC_CANGIM_I0EN);
422 priv->can.state = CAN_STATE_ERROR_ACTIVE;
425 static void ti_hecc_stop(struct net_device *ndev)
427 struct ti_hecc_priv *priv = netdev_priv(ndev);
429 /* Disable interrupts and disable mailboxes */
430 hecc_write(priv, HECC_CANGIM, 0);
431 hecc_write(priv, HECC_CANMIM, 0);
432 hecc_write(priv, HECC_CANME, 0);
433 priv->can.state = CAN_STATE_STOPPED;
436 static int ti_hecc_do_set_mode(struct net_device *ndev, enum can_mode mode)
443 netif_wake_queue(ndev);
453 static int ti_hecc_get_berr_counter(const struct net_device *ndev,
454 struct can_berr_counter *bec)
456 struct ti_hecc_priv *priv = netdev_priv(ndev);
458 bec->txerr = hecc_read(priv, HECC_CANTEC);
459 bec->rxerr = hecc_read(priv, HECC_CANREC);
465 * ti_hecc_xmit: HECC Transmit
467 * The transmit mailboxes start from 0 to HECC_MAX_TX_MBOX. In HECC the
468 * priority of the mailbox for tranmission is dependent upon priority setting
469 * field in mailbox registers. The mailbox with highest value in priority field
470 * is transmitted first. Only when two mailboxes have the same value in
471 * priority field the highest numbered mailbox is transmitted first.
473 * To utilize the HECC priority feature as described above we start with the
474 * highest numbered mailbox with highest priority level and move on to the next
475 * mailbox with the same priority level and so on. Once we loop through all the
476 * transmit mailboxes we choose the next priority level (lower) and so on
477 * until we reach the lowest priority level on the lowest numbered mailbox
478 * when we stop transmission until all mailboxes are transmitted and then
479 * restart at highest numbered mailbox with highest priority.
481 * Two counters (head and tail) are used to track the next mailbox to transmit
482 * and to track the echo buffer for already transmitted mailbox. The queue
483 * is stopped when all the mailboxes are busy or when there is a priority
484 * value roll-over happens.
486 static netdev_tx_t ti_hecc_xmit(struct sk_buff *skb, struct net_device *ndev)
488 struct ti_hecc_priv *priv = netdev_priv(ndev);
489 struct can_frame *cf = (struct can_frame *)skb->data;
490 u32 mbxno, mbx_mask, data;
493 if (can_dropped_invalid_skb(ndev, skb))
496 mbxno = get_tx_head_mb(priv);
497 mbx_mask = BIT(mbxno);
498 spin_lock_irqsave(&priv->mbx_lock, flags);
499 if (unlikely(hecc_read(priv, HECC_CANME) & mbx_mask)) {
500 spin_unlock_irqrestore(&priv->mbx_lock, flags);
501 netif_stop_queue(ndev);
502 netdev_err(priv->ndev,
503 "BUG: TX mbx not ready tx_head=%08X, tx_tail=%08X\n",
504 priv->tx_head, priv->tx_tail);
505 return NETDEV_TX_BUSY;
507 spin_unlock_irqrestore(&priv->mbx_lock, flags);
509 /* Prepare mailbox for transmission */
510 data = cf->can_dlc | (get_tx_head_prio(priv) << 8);
511 if (cf->can_id & CAN_RTR_FLAG) /* Remote transmission request */
512 data |= HECC_CANMCF_RTR;
513 hecc_write_mbx(priv, mbxno, HECC_CANMCF, data);
515 if (cf->can_id & CAN_EFF_FLAG) /* Extended frame format */
516 data = (cf->can_id & CAN_EFF_MASK) | HECC_CANMID_IDE;
517 else /* Standard frame format */
518 data = (cf->can_id & CAN_SFF_MASK) << 18;
519 hecc_write_mbx(priv, mbxno, HECC_CANMID, data);
520 hecc_write_mbx(priv, mbxno, HECC_CANMDL,
521 be32_to_cpu(*(__be32 *)(cf->data)));
523 hecc_write_mbx(priv, mbxno, HECC_CANMDH,
524 be32_to_cpu(*(__be32 *)(cf->data + 4)));
526 *(u32 *)(cf->data + 4) = 0;
527 can_put_echo_skb(skb, ndev, mbxno);
529 spin_lock_irqsave(&priv->mbx_lock, flags);
531 if ((hecc_read(priv, HECC_CANME) & BIT(get_tx_head_mb(priv))) ||
532 (priv->tx_head & HECC_TX_MASK) == HECC_TX_MASK) {
533 netif_stop_queue(ndev);
535 hecc_set_bit(priv, HECC_CANME, mbx_mask);
536 spin_unlock_irqrestore(&priv->mbx_lock, flags);
538 hecc_clear_bit(priv, HECC_CANMD, mbx_mask);
539 hecc_set_bit(priv, HECC_CANMIM, mbx_mask);
540 hecc_write(priv, HECC_CANTRS, mbx_mask);
545 static int ti_hecc_rx_pkt(struct ti_hecc_priv *priv, int mbxno)
547 struct net_device_stats *stats = &priv->ndev->stats;
548 struct can_frame *cf;
553 skb = alloc_can_skb(priv->ndev, &cf);
555 if (printk_ratelimit())
556 netdev_err(priv->ndev,
557 "ti_hecc_rx_pkt: alloc_can_skb() failed\n");
561 mbx_mask = BIT(mbxno);
562 data = hecc_read_mbx(priv, mbxno, HECC_CANMID);
563 if (data & HECC_CANMID_IDE)
564 cf->can_id = (data & CAN_EFF_MASK) | CAN_EFF_FLAG;
566 cf->can_id = (data >> 18) & CAN_SFF_MASK;
567 data = hecc_read_mbx(priv, mbxno, HECC_CANMCF);
568 if (data & HECC_CANMCF_RTR)
569 cf->can_id |= CAN_RTR_FLAG;
570 cf->can_dlc = get_can_dlc(data & 0xF);
571 data = hecc_read_mbx(priv, mbxno, HECC_CANMDL);
572 *(__be32 *)(cf->data) = cpu_to_be32(data);
573 if (cf->can_dlc > 4) {
574 data = hecc_read_mbx(priv, mbxno, HECC_CANMDH);
575 *(__be32 *)(cf->data + 4) = cpu_to_be32(data);
577 spin_lock_irqsave(&priv->mbx_lock, flags);
578 hecc_clear_bit(priv, HECC_CANME, mbx_mask);
579 hecc_write(priv, HECC_CANRMP, mbx_mask);
580 /* enable mailbox only if it is part of rx buffer mailboxes */
581 if (priv->rx_next < HECC_RX_BUFFER_MBOX)
582 hecc_set_bit(priv, HECC_CANME, mbx_mask);
583 spin_unlock_irqrestore(&priv->mbx_lock, flags);
585 stats->rx_bytes += cf->can_dlc;
586 can_led_event(priv->ndev, CAN_LED_EVENT_RX);
587 netif_receive_skb(skb);
594 * ti_hecc_rx_poll - HECC receive pkts
596 * The receive mailboxes start from highest numbered mailbox till last xmit
597 * mailbox. On CAN frame reception the hardware places the data into highest
598 * numbered mailbox that matches the CAN ID filter. Since all receive mailboxes
599 * have same filtering (ALL CAN frames) packets will arrive in the highest
600 * available RX mailbox and we need to ensure in-order packet reception.
602 * To ensure the packets are received in the right order we logically divide
603 * the RX mailboxes into main and buffer mailboxes. Packets are received as per
604 * mailbox priotity (higher to lower) in the main bank and once it is full we
605 * disable further reception into main mailboxes. While the main mailboxes are
606 * processed in NAPI, further packets are received in buffer mailboxes.
608 * We maintain a RX next mailbox counter to process packets and once all main
609 * mailboxe packets are passed to the upper stack we enable all of them but
610 * continue to process packets received in buffer mailboxes. With each packet
611 * received from buffer mailbox we enable it immediately so as to handle the
612 * overflow from higher mailboxes.
614 static int ti_hecc_rx_poll(struct napi_struct *napi, int quota)
616 struct net_device *ndev = napi->dev;
617 struct ti_hecc_priv *priv = netdev_priv(ndev);
620 unsigned long pending_pkts, flags;
622 if (!netif_running(ndev))
625 while ((pending_pkts = hecc_read(priv, HECC_CANRMP)) &&
627 mbx_mask = BIT(priv->rx_next); /* next rx mailbox to process */
628 if (mbx_mask & pending_pkts) {
629 if (ti_hecc_rx_pkt(priv, priv->rx_next) < 0)
632 } else if (priv->rx_next > HECC_RX_BUFFER_MBOX) {
633 break; /* pkt not received yet */
636 if (priv->rx_next == HECC_RX_BUFFER_MBOX) {
637 /* enable high bank mailboxes */
638 spin_lock_irqsave(&priv->mbx_lock, flags);
639 mbx_mask = hecc_read(priv, HECC_CANME);
640 mbx_mask |= HECC_RX_HIGH_MBOX_MASK;
641 hecc_write(priv, HECC_CANME, mbx_mask);
642 spin_unlock_irqrestore(&priv->mbx_lock, flags);
643 } else if (priv->rx_next == HECC_MAX_TX_MBOX - 1) {
644 priv->rx_next = HECC_RX_FIRST_MBOX;
649 /* Enable packet interrupt if all pkts are handled */
650 if (hecc_read(priv, HECC_CANRMP) == 0) {
652 /* Re-enable RX mailbox interrupts */
653 mbx_mask = hecc_read(priv, HECC_CANMIM);
654 mbx_mask |= HECC_TX_MBOX_MASK;
655 hecc_write(priv, HECC_CANMIM, mbx_mask);
661 static int ti_hecc_error(struct net_device *ndev, int int_status,
664 struct ti_hecc_priv *priv = netdev_priv(ndev);
665 struct net_device_stats *stats = &ndev->stats;
666 struct can_frame *cf;
669 /* propagate the error condition to the can stack */
670 skb = alloc_can_err_skb(ndev, &cf);
672 if (printk_ratelimit())
673 netdev_err(priv->ndev,
674 "ti_hecc_error: alloc_can_err_skb() failed\n");
678 if (int_status & HECC_CANGIF_WLIF) { /* warning level int */
679 if ((int_status & HECC_CANGIF_BOIF) == 0) {
680 priv->can.state = CAN_STATE_ERROR_WARNING;
681 ++priv->can.can_stats.error_warning;
682 cf->can_id |= CAN_ERR_CRTL;
683 if (hecc_read(priv, HECC_CANTEC) > 96)
684 cf->data[1] |= CAN_ERR_CRTL_TX_WARNING;
685 if (hecc_read(priv, HECC_CANREC) > 96)
686 cf->data[1] |= CAN_ERR_CRTL_RX_WARNING;
688 hecc_set_bit(priv, HECC_CANES, HECC_CANES_EW);
689 netdev_dbg(priv->ndev, "Error Warning interrupt\n");
690 hecc_clear_bit(priv, HECC_CANMC, HECC_CANMC_CCR);
693 if (int_status & HECC_CANGIF_EPIF) { /* error passive int */
694 if ((int_status & HECC_CANGIF_BOIF) == 0) {
695 priv->can.state = CAN_STATE_ERROR_PASSIVE;
696 ++priv->can.can_stats.error_passive;
697 cf->can_id |= CAN_ERR_CRTL;
698 if (hecc_read(priv, HECC_CANTEC) > 127)
699 cf->data[1] |= CAN_ERR_CRTL_TX_PASSIVE;
700 if (hecc_read(priv, HECC_CANREC) > 127)
701 cf->data[1] |= CAN_ERR_CRTL_RX_PASSIVE;
703 hecc_set_bit(priv, HECC_CANES, HECC_CANES_EP);
704 netdev_dbg(priv->ndev, "Error passive interrupt\n");
705 hecc_clear_bit(priv, HECC_CANMC, HECC_CANMC_CCR);
709 * Need to check busoff condition in error status register too to
710 * ensure warning interrupts don't hog the system
712 if ((int_status & HECC_CANGIF_BOIF) || (err_status & HECC_CANES_BO)) {
713 priv->can.state = CAN_STATE_BUS_OFF;
714 cf->can_id |= CAN_ERR_BUSOFF;
715 hecc_set_bit(priv, HECC_CANES, HECC_CANES_BO);
716 hecc_clear_bit(priv, HECC_CANMC, HECC_CANMC_CCR);
717 /* Disable all interrupts in bus-off to avoid int hog */
718 hecc_write(priv, HECC_CANGIM, 0);
722 if (err_status & HECC_BUS_ERROR) {
723 ++priv->can.can_stats.bus_error;
724 cf->can_id |= CAN_ERR_BUSERROR | CAN_ERR_PROT;
725 cf->data[2] |= CAN_ERR_PROT_UNSPEC;
726 if (err_status & HECC_CANES_FE) {
727 hecc_set_bit(priv, HECC_CANES, HECC_CANES_FE);
728 cf->data[2] |= CAN_ERR_PROT_FORM;
730 if (err_status & HECC_CANES_BE) {
731 hecc_set_bit(priv, HECC_CANES, HECC_CANES_BE);
732 cf->data[2] |= CAN_ERR_PROT_BIT;
734 if (err_status & HECC_CANES_SE) {
735 hecc_set_bit(priv, HECC_CANES, HECC_CANES_SE);
736 cf->data[2] |= CAN_ERR_PROT_STUFF;
738 if (err_status & HECC_CANES_CRCE) {
739 hecc_set_bit(priv, HECC_CANES, HECC_CANES_CRCE);
740 cf->data[3] |= CAN_ERR_PROT_LOC_CRC_SEQ |
741 CAN_ERR_PROT_LOC_CRC_DEL;
743 if (err_status & HECC_CANES_ACKE) {
744 hecc_set_bit(priv, HECC_CANES, HECC_CANES_ACKE);
745 cf->data[3] |= CAN_ERR_PROT_LOC_ACK |
746 CAN_ERR_PROT_LOC_ACK_DEL;
752 stats->rx_bytes += cf->can_dlc;
757 static irqreturn_t ti_hecc_interrupt(int irq, void *dev_id)
759 struct net_device *ndev = (struct net_device *)dev_id;
760 struct ti_hecc_priv *priv = netdev_priv(ndev);
761 struct net_device_stats *stats = &ndev->stats;
762 u32 mbxno, mbx_mask, int_status, err_status;
763 unsigned long ack, flags;
765 int_status = hecc_read(priv,
766 (priv->int_line) ? HECC_CANGIF1 : HECC_CANGIF0);
771 err_status = hecc_read(priv, HECC_CANES);
772 if (err_status & (HECC_BUS_ERROR | HECC_CANES_BO |
773 HECC_CANES_EP | HECC_CANES_EW))
774 ti_hecc_error(ndev, int_status, err_status);
776 if (int_status & HECC_CANGIF_GMIF) {
777 while (priv->tx_tail - priv->tx_head > 0) {
778 mbxno = get_tx_tail_mb(priv);
779 mbx_mask = BIT(mbxno);
780 if (!(mbx_mask & hecc_read(priv, HECC_CANTA)))
782 hecc_clear_bit(priv, HECC_CANMIM, mbx_mask);
783 hecc_write(priv, HECC_CANTA, mbx_mask);
784 spin_lock_irqsave(&priv->mbx_lock, flags);
785 hecc_clear_bit(priv, HECC_CANME, mbx_mask);
786 spin_unlock_irqrestore(&priv->mbx_lock, flags);
787 stats->tx_bytes += hecc_read_mbx(priv, mbxno,
790 can_led_event(ndev, CAN_LED_EVENT_TX);
791 can_get_echo_skb(ndev, mbxno);
795 /* restart queue if wrap-up or if queue stalled on last pkt */
796 if (((priv->tx_head == priv->tx_tail) &&
797 ((priv->tx_head & HECC_TX_MASK) != HECC_TX_MASK)) ||
798 (((priv->tx_tail & HECC_TX_MASK) == HECC_TX_MASK) &&
799 ((priv->tx_head & HECC_TX_MASK) == HECC_TX_MASK)))
800 netif_wake_queue(ndev);
802 /* Disable RX mailbox interrupts and let NAPI reenable them */
803 if (hecc_read(priv, HECC_CANRMP)) {
804 ack = hecc_read(priv, HECC_CANMIM);
805 ack &= BIT(HECC_MAX_TX_MBOX) - 1;
806 hecc_write(priv, HECC_CANMIM, ack);
807 napi_schedule(&priv->napi);
811 /* clear all interrupt conditions - read back to avoid spurious ints */
812 if (priv->int_line) {
813 hecc_write(priv, HECC_CANGIF1, HECC_SET_REG);
814 int_status = hecc_read(priv, HECC_CANGIF1);
816 hecc_write(priv, HECC_CANGIF0, HECC_SET_REG);
817 int_status = hecc_read(priv, HECC_CANGIF0);
823 static int ti_hecc_open(struct net_device *ndev)
825 struct ti_hecc_priv *priv = netdev_priv(ndev);
828 err = request_irq(ndev->irq, ti_hecc_interrupt, IRQF_SHARED,
831 netdev_err(ndev, "error requesting interrupt\n");
835 ti_hecc_transceiver_switch(priv, 1);
837 /* Open common can device */
838 err = open_candev(ndev);
840 netdev_err(ndev, "open_candev() failed %d\n", err);
841 ti_hecc_transceiver_switch(priv, 0);
842 free_irq(ndev->irq, ndev);
846 can_led_event(ndev, CAN_LED_EVENT_OPEN);
849 napi_enable(&priv->napi);
850 netif_start_queue(ndev);
855 static int ti_hecc_close(struct net_device *ndev)
857 struct ti_hecc_priv *priv = netdev_priv(ndev);
859 netif_stop_queue(ndev);
860 napi_disable(&priv->napi);
862 free_irq(ndev->irq, ndev);
864 ti_hecc_transceiver_switch(priv, 0);
866 can_led_event(ndev, CAN_LED_EVENT_STOP);
871 static const struct net_device_ops ti_hecc_netdev_ops = {
872 .ndo_open = ti_hecc_open,
873 .ndo_stop = ti_hecc_close,
874 .ndo_start_xmit = ti_hecc_xmit,
877 static int ti_hecc_probe(struct platform_device *pdev)
879 struct net_device *ndev = (struct net_device *)0;
880 struct ti_hecc_priv *priv;
881 struct ti_hecc_platform_data *pdata;
882 struct resource *mem, *irq;
886 pdata = dev_get_platdata(&pdev->dev);
888 dev_err(&pdev->dev, "No platform data\n");
892 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
894 dev_err(&pdev->dev, "No mem resources\n");
897 irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
899 dev_err(&pdev->dev, "No irq resource\n");
902 if (!request_mem_region(mem->start, resource_size(mem), pdev->name)) {
903 dev_err(&pdev->dev, "HECC region already claimed\n");
907 addr = ioremap(mem->start, resource_size(mem));
909 dev_err(&pdev->dev, "ioremap failed\n");
911 goto probe_exit_free_region;
914 ndev = alloc_candev(sizeof(struct ti_hecc_priv), HECC_MAX_TX_MBOX);
916 dev_err(&pdev->dev, "alloc_candev failed\n");
918 goto probe_exit_iounmap;
921 priv = netdev_priv(ndev);
924 priv->scc_ram_offset = pdata->scc_ram_offset;
925 priv->hecc_ram_offset = pdata->hecc_ram_offset;
926 priv->mbx_offset = pdata->mbx_offset;
927 priv->int_line = pdata->int_line;
928 priv->transceiver_switch = pdata->transceiver_switch;
930 priv->can.bittiming_const = &ti_hecc_bittiming_const;
931 priv->can.do_set_mode = ti_hecc_do_set_mode;
932 priv->can.do_get_berr_counter = ti_hecc_get_berr_counter;
933 priv->can.ctrlmode_supported = CAN_CTRLMODE_3_SAMPLES;
935 spin_lock_init(&priv->mbx_lock);
936 ndev->irq = irq->start;
937 ndev->flags |= IFF_ECHO;
938 platform_set_drvdata(pdev, ndev);
939 SET_NETDEV_DEV(ndev, &pdev->dev);
940 ndev->netdev_ops = &ti_hecc_netdev_ops;
942 priv->clk = clk_get(&pdev->dev, "hecc_ck");
943 if (IS_ERR(priv->clk)) {
944 dev_err(&pdev->dev, "No clock available\n");
945 err = PTR_ERR(priv->clk);
947 goto probe_exit_candev;
949 priv->can.clock.freq = clk_get_rate(priv->clk);
950 netif_napi_add(ndev, &priv->napi, ti_hecc_rx_poll,
951 HECC_DEF_NAPI_WEIGHT);
953 clk_enable(priv->clk);
954 err = register_candev(ndev);
956 dev_err(&pdev->dev, "register_candev() failed\n");
960 devm_can_led_init(ndev);
962 dev_info(&pdev->dev, "device registered (reg_base=%p, irq=%u)\n",
963 priv->base, (u32) ndev->irq);
973 probe_exit_free_region:
974 release_mem_region(mem->start, resource_size(mem));
979 static int ti_hecc_remove(struct platform_device *pdev)
981 struct resource *res;
982 struct net_device *ndev = platform_get_drvdata(pdev);
983 struct ti_hecc_priv *priv = netdev_priv(ndev);
985 unregister_candev(ndev);
986 clk_disable(priv->clk);
988 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
990 release_mem_region(res->start, resource_size(res));
998 static int ti_hecc_suspend(struct platform_device *pdev, pm_message_t state)
1000 struct net_device *dev = platform_get_drvdata(pdev);
1001 struct ti_hecc_priv *priv = netdev_priv(dev);
1003 if (netif_running(dev)) {
1004 netif_stop_queue(dev);
1005 netif_device_detach(dev);
1008 hecc_set_bit(priv, HECC_CANMC, HECC_CANMC_PDR);
1009 priv->can.state = CAN_STATE_SLEEPING;
1011 clk_disable(priv->clk);
1016 static int ti_hecc_resume(struct platform_device *pdev)
1018 struct net_device *dev = platform_get_drvdata(pdev);
1019 struct ti_hecc_priv *priv = netdev_priv(dev);
1021 clk_enable(priv->clk);
1023 hecc_clear_bit(priv, HECC_CANMC, HECC_CANMC_PDR);
1024 priv->can.state = CAN_STATE_ERROR_ACTIVE;
1026 if (netif_running(dev)) {
1027 netif_device_attach(dev);
1028 netif_start_queue(dev);
1034 #define ti_hecc_suspend NULL
1035 #define ti_hecc_resume NULL
1038 /* TI HECC netdevice driver: platform driver structure */
1039 static struct platform_driver ti_hecc_driver = {
1042 .owner = THIS_MODULE,
1044 .probe = ti_hecc_probe,
1045 .remove = ti_hecc_remove,
1046 .suspend = ti_hecc_suspend,
1047 .resume = ti_hecc_resume,
1050 module_platform_driver(ti_hecc_driver);
1052 MODULE_AUTHOR("Anant Gole <anantgole@ti.com>");
1053 MODULE_LICENSE("GPL v2");
1054 MODULE_DESCRIPTION(DRV_DESC);
1055 MODULE_ALIAS("platform:" DRV_NAME);