2 * sja1000.c - Philips SJA1000 network device driver
4 * Copyright (c) 2003 Matthias Brukner, Trajet Gmbh, Rebenring 33,
5 * 38106 Braunschweig, GERMANY
7 * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of Volkswagen nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * Alternatively, provided that this notice is retained in full, this
23 * software may be distributed under the terms of the GNU General
24 * Public License ("GPL") version 2, in which case the provisions of the
25 * GPL apply INSTEAD OF those given above.
27 * The provided data structures and external interfaces from this code
28 * are not restricted to be used by modules with a GPL compatible license.
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
31 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
32 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
33 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
34 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
36 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
37 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
38 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
39 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
40 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
43 * Send feedback to <socketcan-users@lists.berlios.de>
47 #include <linux/module.h>
48 #include <linux/init.h>
49 #include <linux/kernel.h>
50 #include <linux/version.h>
51 #include <linux/sched.h>
52 #include <linux/types.h>
53 #include <linux/fcntl.h>
54 #include <linux/interrupt.h>
55 #include <linux/ptrace.h>
56 #include <linux/string.h>
57 #include <linux/errno.h>
58 #include <linux/netdevice.h>
59 #include <linux/if_arp.h>
60 #include <linux/if_ether.h>
61 #include <linux/skbuff.h>
62 #include <linux/delay.h>
64 #include <socketcan/can.h>
65 #include <socketcan/can/dev.h>
66 #include <socketcan/can/error.h>
70 #include <socketcan/can/version.h> /* for RCSID. Removed by mkpatch script */
71 RCSID("$Id: sja1000.c 531 2007-10-19 07:38:29Z hartkopp $");
73 #define DRV_NAME "sja1000"
75 MODULE_AUTHOR("Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");
76 MODULE_LICENSE("Dual BSD/GPL");
77 MODULE_DESCRIPTION(DRV_NAME "CAN netdevice driver");
79 static struct can_bittiming_const sja1000_bittiming_const = {
91 static void sja1000_write_cmdreg(struct sja1000_priv *priv, u8 val)
96 * The command register needs some locking and time to settle
97 * the write_reg() operation - especially on SMP systems.
99 spin_lock_irqsave(&priv->cmdreg_lock, flags);
100 priv->write_reg(priv, REG_CMR, val);
101 priv->read_reg(priv, REG_SR);
102 spin_unlock_irqrestore(&priv->cmdreg_lock, flags);
105 static int sja1000_probe_chip(struct net_device *dev)
107 struct sja1000_priv *priv = netdev_priv(dev);
109 if (priv->reg_base && (priv->read_reg(priv, 0) == 0xFF)) {
110 dev_info(ND2D(dev), "probing @0x%p failed\n",
117 static void set_reset_mode(struct net_device *dev)
119 struct sja1000_priv *priv = netdev_priv(dev);
120 unsigned char status = priv->read_reg(priv, REG_MOD);
123 /* disable interrupts */
124 priv->write_reg(priv, REG_IER, IRQ_OFF);
126 for (i = 0; i < 100; i++) {
127 /* check reset bit */
128 if (status & MOD_RM) {
129 priv->can.state = CAN_STATE_STOPPED;
133 priv->write_reg(priv, REG_MOD, MOD_RM); /* reset chip */
135 status = priv->read_reg(priv, REG_MOD);
138 dev_err(ND2D(dev), "setting SJA1000 into reset mode failed!\n");
141 static void set_normal_mode(struct net_device *dev)
143 struct sja1000_priv *priv = netdev_priv(dev);
144 unsigned char status = priv->read_reg(priv, REG_MOD);
147 for (i = 0; i < 100; i++) {
148 /* check reset bit */
149 if ((status & MOD_RM) == 0) {
150 priv->can.state = CAN_STATE_ERROR_ACTIVE;
151 /* enable interrupts */
152 if (priv->can.ctrlmode & CAN_CTRLMODE_BERR_REPORTING)
153 priv->write_reg(priv, REG_IER, IRQ_ALL);
155 priv->write_reg(priv, REG_IER,
160 /* set chip to normal mode */
161 priv->write_reg(priv, REG_MOD, 0x00);
163 status = priv->read_reg(priv, REG_MOD);
166 dev_err(ND2D(dev), "setting SJA1000 into normal mode failed!\n");
169 static void sja1000_start(struct net_device *dev)
171 struct sja1000_priv *priv = netdev_priv(dev);
173 /* leave reset mode */
174 if (priv->can.state != CAN_STATE_STOPPED)
177 /* Clear error counters and error code capture */
178 priv->write_reg(priv, REG_TXERR, 0x0);
179 priv->write_reg(priv, REG_RXERR, 0x0);
180 priv->read_reg(priv, REG_ECC);
182 /* leave reset mode */
183 set_normal_mode(dev);
186 static int sja1000_set_mode(struct net_device *dev, enum can_mode mode)
188 struct sja1000_priv *priv = netdev_priv(dev);
190 if (!priv->open_time)
196 if (netif_queue_stopped(dev))
197 netif_wake_queue(dev);
207 static int sja1000_set_bittiming(struct net_device *dev)
209 struct sja1000_priv *priv = netdev_priv(dev);
210 struct can_bittiming *bt = &priv->can.bittiming;
213 btr0 = ((bt->brp - 1) & 0x3f) | (((bt->sjw - 1) & 0x3) << 6);
214 btr1 = ((bt->prop_seg + bt->phase_seg1 - 1) & 0xf) |
215 (((bt->phase_seg2 - 1) & 0x7) << 4);
216 if (priv->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES)
220 "setting BTR0=0x%02x BTR1=0x%02x\n", btr0, btr1);
222 priv->write_reg(priv, REG_BTR0, btr0);
223 priv->write_reg(priv, REG_BTR1, btr1);
228 static int sja1000_get_berr_counter(const struct net_device *dev,
229 struct can_berr_counter *bec)
231 struct sja1000_priv *priv = netdev_priv(dev);
233 bec->txerr = priv->read_reg(priv, REG_TXERR);
234 bec->rxerr = priv->read_reg(priv, REG_RXERR);
240 * initialize SJA1000 chip:
244 * - enable interrupts
245 * - start operating mode
247 static void chipset_init(struct net_device *dev)
249 struct sja1000_priv *priv = netdev_priv(dev);
251 /* set clock divider and output control register */
252 priv->write_reg(priv, REG_CDR, priv->cdr | CDR_PELICAN);
254 /* set acceptance filter (accept all) */
255 priv->write_reg(priv, REG_ACCC0, 0x00);
256 priv->write_reg(priv, REG_ACCC1, 0x00);
257 priv->write_reg(priv, REG_ACCC2, 0x00);
258 priv->write_reg(priv, REG_ACCC3, 0x00);
260 priv->write_reg(priv, REG_ACCM0, 0xFF);
261 priv->write_reg(priv, REG_ACCM1, 0xFF);
262 priv->write_reg(priv, REG_ACCM2, 0xFF);
263 priv->write_reg(priv, REG_ACCM3, 0xFF);
265 priv->write_reg(priv, REG_OCR, priv->ocr | OCR_MODE_NORMAL);
269 * transmit a CAN message
270 * message layout in the sk_buff should be like this:
271 * xx xx xx xx ff ll 00 11 22 33 44 55 66 77
272 * [ can-id ] [flags] [len] [can data (up to 8 bytes]
274 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
275 static int sja1000_start_xmit(struct sk_buff *skb, struct net_device *dev)
277 static netdev_tx_t sja1000_start_xmit(struct sk_buff *skb,
278 struct net_device *dev)
281 struct sja1000_priv *priv = netdev_priv(dev);
282 struct can_frame *cf = (struct can_frame *)skb->data;
289 if (can_dropped_invalid_skb(dev, skb))
292 netif_stop_queue(dev);
294 fi = dlc = cf->can_dlc;
297 if (id & CAN_RTR_FLAG)
300 if (id & CAN_EFF_FLAG) {
303 priv->write_reg(priv, REG_FI, fi);
304 priv->write_reg(priv, REG_ID1, (id & 0x1fe00000) >> (5 + 16));
305 priv->write_reg(priv, REG_ID2, (id & 0x001fe000) >> (5 + 8));
306 priv->write_reg(priv, REG_ID3, (id & 0x00001fe0) >> 5);
307 priv->write_reg(priv, REG_ID4, (id & 0x0000001f) << 3);
310 priv->write_reg(priv, REG_FI, fi);
311 priv->write_reg(priv, REG_ID1, (id & 0x000007f8) >> 3);
312 priv->write_reg(priv, REG_ID2, (id & 0x00000007) << 5);
315 for (i = 0; i < dlc; i++)
316 priv->write_reg(priv, dreg++, cf->data[i]);
318 dev->trans_start = jiffies;
320 can_put_echo_skb(skb, dev, 0);
322 sja1000_write_cmdreg(priv, CMD_TR);
327 static void sja1000_rx(struct net_device *dev)
329 struct sja1000_priv *priv = netdev_priv(dev);
330 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
331 struct net_device_stats *stats = can_get_stats(dev);
333 struct net_device_stats *stats = &dev->stats;
335 struct can_frame *cf;
342 /* create zero'ed CAN frame buffer */
343 skb = alloc_can_skb(dev, &cf);
347 fi = priv->read_reg(priv, REG_FI);
350 /* extended frame format (EFF) */
352 id = (priv->read_reg(priv, REG_ID1) << (5 + 16))
353 | (priv->read_reg(priv, REG_ID2) << (5 + 8))
354 | (priv->read_reg(priv, REG_ID3) << 5)
355 | (priv->read_reg(priv, REG_ID4) >> 3);
358 /* standard frame format (SFF) */
360 id = (priv->read_reg(priv, REG_ID1) << 3)
361 | (priv->read_reg(priv, REG_ID2) >> 5);
367 cf->can_dlc = get_can_dlc(fi & 0x0F);
368 for (i = 0; i < cf->can_dlc; i++)
369 cf->data[i] = priv->read_reg(priv, dreg++);
374 /* release receive buffer */
375 sja1000_write_cmdreg(priv, CMD_RRB);
379 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
380 dev->last_rx = jiffies;
383 stats->rx_bytes += cf->can_dlc;
386 static int sja1000_err(struct net_device *dev, uint8_t isrc, uint8_t status)
388 struct sja1000_priv *priv = netdev_priv(dev);
389 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
390 struct net_device_stats *stats = can_get_stats(dev);
392 struct net_device_stats *stats = &dev->stats;
394 struct can_frame *cf;
396 enum can_state state = priv->can.state;
399 skb = alloc_can_err_skb(dev, &cf);
403 if (isrc & IRQ_DOI) {
404 /* data overrun interrupt */
405 dev_dbg(ND2D(dev), "data overrun interrupt\n");
406 cf->can_id |= CAN_ERR_CRTL;
407 cf->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
408 stats->rx_over_errors++;
410 sja1000_write_cmdreg(priv, CMD_CDO); /* clear bit */
414 /* error warning interrupt */
415 dev_dbg(ND2D(dev), "error warning interrupt\n");
417 if (status & SR_BS) {
418 state = CAN_STATE_BUS_OFF;
419 cf->can_id |= CAN_ERR_BUSOFF;
421 } else if (status & SR_ES) {
422 state = CAN_STATE_ERROR_WARNING;
424 state = CAN_STATE_ERROR_ACTIVE;
426 if (isrc & IRQ_BEI) {
427 /* bus error interrupt */
428 priv->can.can_stats.bus_error++;
431 ecc = priv->read_reg(priv, REG_ECC);
433 cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
435 switch (ecc & ECC_MASK) {
437 cf->data[2] |= CAN_ERR_PROT_BIT;
440 cf->data[2] |= CAN_ERR_PROT_FORM;
443 cf->data[2] |= CAN_ERR_PROT_STUFF;
446 cf->data[2] |= CAN_ERR_PROT_UNSPEC;
447 cf->data[3] = ecc & ECC_SEG;
450 /* Error occurred during transmission? */
451 if ((ecc & ECC_DIR) == 0)
452 cf->data[2] |= CAN_ERR_PROT_TX;
454 if (isrc & IRQ_EPI) {
455 /* error passive interrupt */
456 dev_dbg(ND2D(dev), "error passive interrupt\n");
458 state = CAN_STATE_ERROR_PASSIVE;
460 state = CAN_STATE_ERROR_ACTIVE;
462 if (isrc & IRQ_ALI) {
463 /* arbitration lost interrupt */
464 dev_dbg(ND2D(dev), "arbitration lost interrupt\n");
465 alc = priv->read_reg(priv, REG_ALC);
466 priv->can.can_stats.arbitration_lost++;
468 cf->can_id |= CAN_ERR_LOSTARB;
469 cf->data[0] = alc & 0x1f;
472 if (state != priv->can.state && (state == CAN_STATE_ERROR_WARNING ||
473 state == CAN_STATE_ERROR_PASSIVE)) {
474 uint8_t rxerr = priv->read_reg(priv, REG_RXERR);
475 uint8_t txerr = priv->read_reg(priv, REG_TXERR);
476 cf->can_id |= CAN_ERR_CRTL;
477 if (state == CAN_STATE_ERROR_WARNING) {
478 priv->can.can_stats.error_warning++;
479 cf->data[1] = (txerr > rxerr) ?
480 CAN_ERR_CRTL_TX_WARNING :
481 CAN_ERR_CRTL_RX_WARNING;
483 priv->can.can_stats.error_passive++;
484 cf->data[1] = (txerr > rxerr) ?
485 CAN_ERR_CRTL_TX_PASSIVE :
486 CAN_ERR_CRTL_RX_PASSIVE;
492 priv->can.state = state;
496 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
497 dev->last_rx = jiffies;
500 stats->rx_bytes += cf->can_dlc;
505 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,19)
506 irqreturn_t sja1000_interrupt(int irq, void *dev_id, struct pt_regs *regs)
508 irqreturn_t sja1000_interrupt(int irq, void *dev_id)
511 struct net_device *dev = (struct net_device *)dev_id;
512 struct sja1000_priv *priv = netdev_priv(dev);
513 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
514 struct net_device_stats *stats = can_get_stats(dev);
516 struct net_device_stats *stats = &dev->stats;
518 uint8_t isrc, status;
521 /* Shared interrupts and IRQ off? */
522 if (priv->read_reg(priv, REG_IER) == IRQ_OFF)
528 while ((isrc = priv->read_reg(priv, REG_IR)) && (n < SJA1000_MAX_IRQ)) {
530 status = priv->read_reg(priv, REG_SR);
533 dev_warn(ND2D(dev), "wakeup interrupt\n");
536 /* transmission complete interrupt */
537 stats->tx_bytes += priv->read_reg(priv, REG_FI) & 0xf;
539 can_get_echo_skb(dev, 0);
540 netif_wake_queue(dev);
543 /* receive interrupt */
544 while (status & SR_RBS) {
546 status = priv->read_reg(priv, REG_SR);
549 if (isrc & (IRQ_DOI | IRQ_EI | IRQ_BEI | IRQ_EPI | IRQ_ALI)) {
550 /* error interrupt */
551 if (sja1000_err(dev, isrc, status))
557 priv->post_irq(priv);
559 if (n >= SJA1000_MAX_IRQ)
560 dev_dbg(ND2D(dev), "%d messages handled in ISR", n);
562 return (n) ? IRQ_HANDLED : IRQ_NONE;
564 EXPORT_SYMBOL_GPL(sja1000_interrupt);
566 static int sja1000_open(struct net_device *dev)
568 struct sja1000_priv *priv = netdev_priv(dev);
571 /* set chip into reset mode */
575 err = open_candev(dev);
579 /* register interrupt handler, if not done by the device driver */
580 if (!(priv->flags & SJA1000_CUSTOM_IRQ_HANDLER)) {
581 err = request_irq(dev->irq, sja1000_interrupt, priv->irq_flags,
582 dev->name, (void *)dev);
589 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
590 /* clear statistics */
591 memset(&priv->can.net_stats, 0, sizeof(priv->can.net_stats));
594 /* init and start chi */
596 priv->open_time = jiffies;
598 netif_start_queue(dev);
603 static int sja1000_close(struct net_device *dev)
605 struct sja1000_priv *priv = netdev_priv(dev);
607 netif_stop_queue(dev);
610 if (!(priv->flags & SJA1000_CUSTOM_IRQ_HANDLER))
611 free_irq(dev->irq, (void *)dev);
620 struct net_device *alloc_sja1000dev(int sizeof_priv)
622 struct net_device *dev;
623 struct sja1000_priv *priv;
625 dev = alloc_candev(sizeof(struct sja1000_priv) + sizeof_priv,
626 SJA1000_ECHO_SKB_MAX);
630 priv = netdev_priv(dev);
633 priv->can.bittiming_const = &sja1000_bittiming_const;
634 priv->can.do_set_bittiming = sja1000_set_bittiming;
635 priv->can.do_set_mode = sja1000_set_mode;
636 priv->can.do_get_berr_counter = sja1000_get_berr_counter;
637 priv->can.ctrlmode_supported = CAN_CTRLMODE_3_SAMPLES |
638 CAN_CTRLMODE_BERR_REPORTING;
640 spin_lock_init(&priv->cmdreg_lock);
643 priv->priv = (void *)priv + sizeof(struct sja1000_priv);
647 EXPORT_SYMBOL_GPL(alloc_sja1000dev);
649 void free_sja1000dev(struct net_device *dev)
653 EXPORT_SYMBOL_GPL(free_sja1000dev);
655 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
656 static const struct net_device_ops sja1000_netdev_ops = {
657 .ndo_open = sja1000_open,
658 .ndo_stop = sja1000_close,
659 .ndo_start_xmit = sja1000_start_xmit,
663 int register_sja1000dev(struct net_device *dev)
665 if (!sja1000_probe_chip(dev))
668 dev->flags |= IFF_ECHO; /* we support local echo */
669 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
670 dev->netdev_ops = &sja1000_netdev_ops;
672 dev->open = sja1000_open;
673 dev->stop = sja1000_close;
674 dev->hard_start_xmit = sja1000_start_xmit;
680 return register_candev(dev);
682 EXPORT_SYMBOL_GPL(register_sja1000dev);
684 void unregister_sja1000dev(struct net_device *dev)
687 unregister_candev(dev);
689 EXPORT_SYMBOL_GPL(unregister_sja1000dev);
691 static __init int sja1000_init(void)
693 printk(KERN_INFO "%s CAN netdevice driver\n", DRV_NAME);
698 module_init(sja1000_init);
700 static __exit void sja1000_exit(void)
702 printk(KERN_INFO "%s: driver removed\n", DRV_NAME);
705 module_exit(sja1000_exit);