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 int sja1000_probe_chip(struct net_device *dev)
93 struct sja1000_priv *priv = netdev_priv(dev);
95 if (priv->reg_base && (priv->read_reg(priv, 0) == 0xFF)) {
96 dev_info(ND2D(dev), "probing @0x%p failed\n",
103 static void set_reset_mode(struct net_device *dev)
105 struct sja1000_priv *priv = netdev_priv(dev);
106 unsigned char status = priv->read_reg(priv, REG_MOD);
109 /* disable interrupts */
110 priv->write_reg(priv, REG_IER, IRQ_OFF);
112 for (i = 0; i < 100; i++) {
113 /* check reset bit */
114 if (status & MOD_RM) {
115 priv->can.state = CAN_STATE_STOPPED;
119 priv->write_reg(priv, REG_MOD, MOD_RM); /* reset chip */
121 status = priv->read_reg(priv, REG_MOD);
124 dev_err(ND2D(dev), "setting SJA1000 into reset mode failed!\n");
127 static void set_normal_mode(struct net_device *dev)
129 struct sja1000_priv *priv = netdev_priv(dev);
130 unsigned char status = priv->read_reg(priv, REG_MOD);
133 for (i = 0; i < 100; i++) {
134 /* check reset bit */
135 if ((status & MOD_RM) == 0) {
136 priv->can.state = CAN_STATE_ERROR_ACTIVE;
137 /* enable all interrupts */
138 priv->write_reg(priv, REG_IER, IRQ_ALL);
142 /* set chip to normal mode */
143 priv->write_reg(priv, REG_MOD, 0x00);
145 status = priv->read_reg(priv, REG_MOD);
148 dev_err(ND2D(dev), "setting SJA1000 into normal mode failed!\n");
151 static void sja1000_start(struct net_device *dev)
153 struct sja1000_priv *priv = netdev_priv(dev);
155 /* leave reset mode */
156 if (priv->can.state != CAN_STATE_STOPPED)
159 /* Clear error counters and error code capture */
160 priv->write_reg(priv, REG_TXERR, 0x0);
161 priv->write_reg(priv, REG_RXERR, 0x0);
162 priv->read_reg(priv, REG_ECC);
164 /* leave reset mode */
165 set_normal_mode(dev);
168 static int sja1000_set_mode(struct net_device *dev, enum can_mode mode)
170 struct sja1000_priv *priv = netdev_priv(dev);
172 if (!priv->open_time)
178 if (netif_queue_stopped(dev))
179 netif_wake_queue(dev);
189 static int sja1000_set_bittiming(struct net_device *dev)
191 struct sja1000_priv *priv = netdev_priv(dev);
192 struct can_bittiming *bt = &priv->can.bittiming;
195 btr0 = ((bt->brp - 1) & 0x3f) | (((bt->sjw - 1) & 0x3) << 6);
196 btr1 = ((bt->prop_seg + bt->phase_seg1 - 1) & 0xf) |
197 (((bt->phase_seg2 - 1) & 0x7) << 4);
198 if (priv->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES)
202 "setting BTR0=0x%02x BTR1=0x%02x\n", btr0, btr1);
204 priv->write_reg(priv, REG_BTR0, btr0);
205 priv->write_reg(priv, REG_BTR1, btr1);
211 * initialize SJA1000 chip:
215 * - enable interrupts
216 * - start operating mode
218 static void chipset_init(struct net_device *dev)
220 struct sja1000_priv *priv = netdev_priv(dev);
222 /* set clock divider and output control register */
223 priv->write_reg(priv, REG_CDR, priv->cdr | CDR_PELICAN);
225 /* set acceptance filter (accept all) */
226 priv->write_reg(priv, REG_ACCC0, 0x00);
227 priv->write_reg(priv, REG_ACCC1, 0x00);
228 priv->write_reg(priv, REG_ACCC2, 0x00);
229 priv->write_reg(priv, REG_ACCC3, 0x00);
231 priv->write_reg(priv, REG_ACCM0, 0xFF);
232 priv->write_reg(priv, REG_ACCM1, 0xFF);
233 priv->write_reg(priv, REG_ACCM2, 0xFF);
234 priv->write_reg(priv, REG_ACCM3, 0xFF);
236 priv->write_reg(priv, REG_OCR, priv->ocr | OCR_MODE_NORMAL);
240 * transmit a CAN message
241 * message layout in the sk_buff should be like this:
242 * xx xx xx xx ff ll 00 11 22 33 44 55 66 77
243 * [ can-id ] [flags] [len] [can data (up to 8 bytes]
245 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
246 static int sja1000_start_xmit(struct sk_buff *skb, struct net_device *dev)
248 static netdev_tx_t sja1000_start_xmit(struct sk_buff *skb,
249 struct net_device *dev)
252 struct sja1000_priv *priv = netdev_priv(dev);
253 struct can_frame *cf = (struct can_frame *)skb->data;
260 netif_stop_queue(dev);
262 fi = dlc = cf->can_dlc;
265 if (id & CAN_RTR_FLAG)
268 if (id & CAN_EFF_FLAG) {
271 priv->write_reg(priv, REG_FI, fi);
272 priv->write_reg(priv, REG_ID1, (id & 0x1fe00000) >> (5 + 16));
273 priv->write_reg(priv, REG_ID2, (id & 0x001fe000) >> (5 + 8));
274 priv->write_reg(priv, REG_ID3, (id & 0x00001fe0) >> 5);
275 priv->write_reg(priv, REG_ID4, (id & 0x0000001f) << 3);
278 priv->write_reg(priv, REG_FI, fi);
279 priv->write_reg(priv, REG_ID1, (id & 0x000007f8) >> 3);
280 priv->write_reg(priv, REG_ID2, (id & 0x00000007) << 5);
283 for (i = 0; i < dlc; i++)
284 priv->write_reg(priv, dreg++, cf->data[i]);
286 dev->trans_start = jiffies;
288 can_put_echo_skb(skb, dev, 0);
290 priv->write_reg(priv, REG_CMR, CMD_TR);
295 static void sja1000_rx(struct net_device *dev)
297 struct sja1000_priv *priv = netdev_priv(dev);
298 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
299 struct net_device_stats *stats = can_get_stats(dev);
301 struct net_device_stats *stats = &dev->stats;
303 struct can_frame *cf;
311 skb = alloc_can_skb(dev, &cf);
315 fi = priv->read_reg(priv, REG_FI);
319 /* extended frame format (EFF) */
321 id = (priv->read_reg(priv, REG_ID1) << (5 + 16))
322 | (priv->read_reg(priv, REG_ID2) << (5 + 8))
323 | (priv->read_reg(priv, REG_ID3) << 5)
324 | (priv->read_reg(priv, REG_ID4) >> 3);
327 /* standard frame format (SFF) */
329 id = (priv->read_reg(priv, REG_ID1) << 3)
330 | (priv->read_reg(priv, REG_ID2) >> 5);
336 cf = (struct can_frame *)skb_put(skb, sizeof(struct can_frame));
337 memset(cf, 0, sizeof(struct can_frame));
340 for (i = 0; i < dlc; i++)
341 cf->data[i] = priv->read_reg(priv, dreg++);
346 /* release receive buffer */
347 priv->write_reg(priv, REG_CMR, CMD_RRB);
351 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
352 dev->last_rx = jiffies;
355 stats->rx_bytes += dlc;
358 static int sja1000_err(struct net_device *dev, uint8_t isrc, uint8_t status)
360 struct sja1000_priv *priv = netdev_priv(dev);
361 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
362 struct net_device_stats *stats = can_get_stats(dev);
364 struct net_device_stats *stats = &dev->stats;
366 struct can_frame *cf;
368 enum can_state state = priv->can.state;
371 skb = alloc_can_err_skb(dev, &cf);
375 if (isrc & IRQ_DOI) {
376 /* data overrun interrupt */
377 dev_dbg(ND2D(dev), "data overrun interrupt\n");
378 cf->can_id |= CAN_ERR_CRTL;
379 cf->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
380 stats->rx_over_errors++;
382 priv->write_reg(priv, REG_CMR, CMD_CDO); /* clear bit */
386 /* error warning interrupt */
387 dev_dbg(ND2D(dev), "error warning interrupt\n");
389 if (status & SR_BS) {
390 state = CAN_STATE_BUS_OFF;
391 cf->can_id |= CAN_ERR_BUSOFF;
393 } else if (status & SR_ES) {
394 state = CAN_STATE_ERROR_WARNING;
396 state = CAN_STATE_ERROR_ACTIVE;
398 if (isrc & IRQ_BEI) {
399 /* bus error interrupt */
400 priv->can.can_stats.bus_error++;
403 ecc = priv->read_reg(priv, REG_ECC);
405 cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
407 switch (ecc & ECC_MASK) {
409 cf->data[2] |= CAN_ERR_PROT_BIT;
412 cf->data[2] |= CAN_ERR_PROT_FORM;
415 cf->data[2] |= CAN_ERR_PROT_STUFF;
418 cf->data[2] |= CAN_ERR_PROT_UNSPEC;
419 cf->data[3] = ecc & ECC_SEG;
422 /* Error occured during transmission? */
423 if ((ecc & ECC_DIR) == 0)
424 cf->data[2] |= CAN_ERR_PROT_TX;
426 if (isrc & IRQ_EPI) {
427 /* error passive interrupt */
428 dev_dbg(ND2D(dev), "error passive interrupt\n");
430 state = CAN_STATE_ERROR_PASSIVE;
432 state = CAN_STATE_ERROR_ACTIVE;
434 if (isrc & IRQ_ALI) {
435 /* arbitration lost interrupt */
436 dev_dbg(ND2D(dev), "arbitration lost interrupt\n");
437 alc = priv->read_reg(priv, REG_ALC);
438 priv->can.can_stats.arbitration_lost++;
440 cf->can_id |= CAN_ERR_LOSTARB;
441 cf->data[0] = alc & 0x1f;
444 if (state != priv->can.state && (state == CAN_STATE_ERROR_WARNING ||
445 state == CAN_STATE_ERROR_PASSIVE)) {
446 uint8_t rxerr = priv->read_reg(priv, REG_RXERR);
447 uint8_t txerr = priv->read_reg(priv, REG_TXERR);
448 cf->can_id |= CAN_ERR_CRTL;
449 if (state == CAN_STATE_ERROR_WARNING) {
450 priv->can.can_stats.error_warning++;
451 cf->data[1] = (txerr > rxerr) ?
452 CAN_ERR_CRTL_TX_WARNING :
453 CAN_ERR_CRTL_RX_WARNING;
455 priv->can.can_stats.error_passive++;
456 cf->data[1] = (txerr > rxerr) ?
457 CAN_ERR_CRTL_TX_PASSIVE :
458 CAN_ERR_CRTL_RX_PASSIVE;
462 priv->can.state = state;
466 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
467 dev->last_rx = jiffies;
470 stats->rx_bytes += cf->can_dlc;
475 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,19)
476 irqreturn_t sja1000_interrupt(int irq, void *dev_id, struct pt_regs *regs)
478 irqreturn_t sja1000_interrupt(int irq, void *dev_id)
481 struct net_device *dev = (struct net_device *)dev_id;
482 struct sja1000_priv *priv = netdev_priv(dev);
483 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
484 struct net_device_stats *stats = can_get_stats(dev);
486 struct net_device_stats *stats = &dev->stats;
488 uint8_t isrc, status;
491 /* Shared interrupts and IRQ off? */
492 if (priv->read_reg(priv, REG_IER) == IRQ_OFF)
498 while ((isrc = priv->read_reg(priv, REG_IR)) && (n < SJA1000_MAX_IRQ)) {
500 status = priv->read_reg(priv, REG_SR);
503 dev_warn(ND2D(dev), "wakeup interrupt\n");
506 /* transmission complete interrupt */
507 stats->tx_bytes += priv->read_reg(priv, REG_FI) & 0xf;
509 can_get_echo_skb(dev, 0);
510 netif_wake_queue(dev);
513 /* receive interrupt */
514 while (status & SR_RBS) {
516 status = priv->read_reg(priv, REG_SR);
519 if (isrc & (IRQ_DOI | IRQ_EI | IRQ_BEI | IRQ_EPI | IRQ_ALI)) {
520 /* error interrupt */
521 if (sja1000_err(dev, isrc, status))
527 priv->post_irq(priv);
529 if (n >= SJA1000_MAX_IRQ)
530 dev_dbg(ND2D(dev), "%d messages handled in ISR", n);
532 return (n) ? IRQ_HANDLED : IRQ_NONE;
534 EXPORT_SYMBOL_GPL(sja1000_interrupt);
536 static int sja1000_open(struct net_device *dev)
538 struct sja1000_priv *priv = netdev_priv(dev);
541 /* set chip into reset mode */
545 err = open_candev(dev);
549 /* register interrupt handler, if not done by the device driver */
550 if (!(priv->flags & SJA1000_CUSTOM_IRQ_HANDLER)) {
551 err = request_irq(dev->irq, &sja1000_interrupt, priv->irq_flags,
552 dev->name, (void *)dev);
559 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
560 /* clear statistics */
561 memset(&priv->can.net_stats, 0, sizeof(priv->can.net_stats));
564 /* init and start chi */
566 priv->open_time = jiffies;
568 netif_start_queue(dev);
573 static int sja1000_close(struct net_device *dev)
575 struct sja1000_priv *priv = netdev_priv(dev);
577 netif_stop_queue(dev);
580 if (!(priv->flags & SJA1000_CUSTOM_IRQ_HANDLER))
581 free_irq(dev->irq, (void *)dev);
590 struct net_device *alloc_sja1000dev(int sizeof_priv)
592 struct net_device *dev;
593 struct sja1000_priv *priv;
595 dev = alloc_candev(sizeof(struct sja1000_priv) + sizeof_priv,
596 SJA1000_ECHO_SKB_MAX);
600 priv = netdev_priv(dev);
603 priv->can.bittiming_const = &sja1000_bittiming_const;
604 priv->can.do_set_bittiming = sja1000_set_bittiming;
605 priv->can.do_set_mode = sja1000_set_mode;
608 priv->priv = (void *)priv + sizeof(struct sja1000_priv);
612 EXPORT_SYMBOL_GPL(alloc_sja1000dev);
614 void free_sja1000dev(struct net_device *dev)
618 EXPORT_SYMBOL_GPL(free_sja1000dev);
620 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
621 static const struct net_device_ops sja1000_netdev_ops = {
622 .ndo_open = sja1000_open,
623 .ndo_stop = sja1000_close,
624 .ndo_start_xmit = sja1000_start_xmit,
628 int register_sja1000dev(struct net_device *dev)
630 if (!sja1000_probe_chip(dev))
633 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
634 dev->netdev_ops = &sja1000_netdev_ops;
636 dev->open = sja1000_open;
637 dev->stop = sja1000_close;
638 dev->hard_start_xmit = sja1000_start_xmit;
641 dev->flags |= IFF_ECHO; /* we support local echo */
646 return register_candev(dev);
648 EXPORT_SYMBOL_GPL(register_sja1000dev);
650 void unregister_sja1000dev(struct net_device *dev)
653 unregister_candev(dev);
655 EXPORT_SYMBOL_GPL(unregister_sja1000dev);
657 static __init int sja1000_init(void)
659 printk(KERN_INFO "%s CAN netdevice driver\n", DRV_NAME);
664 module_init(sja1000_init);
666 static __exit void sja1000_exit(void)
668 printk(KERN_INFO "%s: driver removed\n", DRV_NAME);
671 module_exit(sja1000_exit);