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 interrupts */
138 if (priv->can.ctrlmode & CAN_CTRLMODE_BERR_REPORTING)
139 priv->write_reg(priv, REG_IER, IRQ_ALL);
141 priv->write_reg(priv, REG_IER,
146 /* set chip to normal mode */
147 priv->write_reg(priv, REG_MOD, 0x00);
149 status = priv->read_reg(priv, REG_MOD);
152 dev_err(ND2D(dev), "setting SJA1000 into normal mode failed!\n");
155 static void sja1000_start(struct net_device *dev)
157 struct sja1000_priv *priv = netdev_priv(dev);
159 /* leave reset mode */
160 if (priv->can.state != CAN_STATE_STOPPED)
163 /* Clear error counters and error code capture */
164 priv->write_reg(priv, REG_TXERR, 0x0);
165 priv->write_reg(priv, REG_RXERR, 0x0);
166 priv->read_reg(priv, REG_ECC);
168 /* leave reset mode */
169 set_normal_mode(dev);
172 static int sja1000_set_mode(struct net_device *dev, enum can_mode mode)
174 struct sja1000_priv *priv = netdev_priv(dev);
176 if (!priv->open_time)
182 if (netif_queue_stopped(dev))
183 netif_wake_queue(dev);
193 static int sja1000_set_bittiming(struct net_device *dev)
195 struct sja1000_priv *priv = netdev_priv(dev);
196 struct can_bittiming *bt = &priv->can.bittiming;
199 btr0 = ((bt->brp - 1) & 0x3f) | (((bt->sjw - 1) & 0x3) << 6);
200 btr1 = ((bt->prop_seg + bt->phase_seg1 - 1) & 0xf) |
201 (((bt->phase_seg2 - 1) & 0x7) << 4);
202 if (priv->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES)
206 "setting BTR0=0x%02x BTR1=0x%02x\n", btr0, btr1);
208 priv->write_reg(priv, REG_BTR0, btr0);
209 priv->write_reg(priv, REG_BTR1, btr1);
214 static int sja1000_get_berr_counter(const struct net_device *dev,
215 struct can_berr_counter *bec)
217 struct sja1000_priv *priv = netdev_priv(dev);
219 bec->txerr = priv->read_reg(priv, REG_TXERR);
220 bec->rxerr = priv->read_reg(priv, REG_RXERR);
226 * initialize SJA1000 chip:
230 * - enable interrupts
231 * - start operating mode
233 static void chipset_init(struct net_device *dev)
235 struct sja1000_priv *priv = netdev_priv(dev);
237 /* set clock divider and output control register */
238 priv->write_reg(priv, REG_CDR, priv->cdr | CDR_PELICAN);
240 /* set acceptance filter (accept all) */
241 priv->write_reg(priv, REG_ACCC0, 0x00);
242 priv->write_reg(priv, REG_ACCC1, 0x00);
243 priv->write_reg(priv, REG_ACCC2, 0x00);
244 priv->write_reg(priv, REG_ACCC3, 0x00);
246 priv->write_reg(priv, REG_ACCM0, 0xFF);
247 priv->write_reg(priv, REG_ACCM1, 0xFF);
248 priv->write_reg(priv, REG_ACCM2, 0xFF);
249 priv->write_reg(priv, REG_ACCM3, 0xFF);
251 priv->write_reg(priv, REG_OCR, priv->ocr | OCR_MODE_NORMAL);
255 * transmit a CAN message
256 * message layout in the sk_buff should be like this:
257 * xx xx xx xx ff ll 00 11 22 33 44 55 66 77
258 * [ can-id ] [flags] [len] [can data (up to 8 bytes]
260 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
261 static int sja1000_start_xmit(struct sk_buff *skb, struct net_device *dev)
263 static netdev_tx_t sja1000_start_xmit(struct sk_buff *skb,
264 struct net_device *dev)
267 struct sja1000_priv *priv = netdev_priv(dev);
268 struct can_frame *cf = (struct can_frame *)skb->data;
275 if (can_dropped_invalid_skb(dev, skb))
278 netif_stop_queue(dev);
280 fi = dlc = cf->can_dlc;
283 if (id & CAN_RTR_FLAG)
286 if (id & CAN_EFF_FLAG) {
289 priv->write_reg(priv, REG_FI, fi);
290 priv->write_reg(priv, REG_ID1, (id & 0x1fe00000) >> (5 + 16));
291 priv->write_reg(priv, REG_ID2, (id & 0x001fe000) >> (5 + 8));
292 priv->write_reg(priv, REG_ID3, (id & 0x00001fe0) >> 5);
293 priv->write_reg(priv, REG_ID4, (id & 0x0000001f) << 3);
296 priv->write_reg(priv, REG_FI, fi);
297 priv->write_reg(priv, REG_ID1, (id & 0x000007f8) >> 3);
298 priv->write_reg(priv, REG_ID2, (id & 0x00000007) << 5);
301 for (i = 0; i < dlc; i++)
302 priv->write_reg(priv, dreg++, cf->data[i]);
304 dev->trans_start = jiffies;
306 can_put_echo_skb(skb, dev, 0);
308 priv->write_reg(priv, REG_CMR, CMD_TR);
313 static void sja1000_rx(struct net_device *dev)
315 struct sja1000_priv *priv = netdev_priv(dev);
316 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
317 struct net_device_stats *stats = can_get_stats(dev);
319 struct net_device_stats *stats = &dev->stats;
321 struct can_frame *cf;
328 /* create zero'ed CAN frame buffer */
329 skb = alloc_can_skb(dev, &cf);
333 fi = priv->read_reg(priv, REG_FI);
336 /* extended frame format (EFF) */
338 id = (priv->read_reg(priv, REG_ID1) << (5 + 16))
339 | (priv->read_reg(priv, REG_ID2) << (5 + 8))
340 | (priv->read_reg(priv, REG_ID3) << 5)
341 | (priv->read_reg(priv, REG_ID4) >> 3);
344 /* standard frame format (SFF) */
346 id = (priv->read_reg(priv, REG_ID1) << 3)
347 | (priv->read_reg(priv, REG_ID2) >> 5);
353 cf->can_dlc = get_can_dlc(fi & 0x0F);
354 for (i = 0; i < cf->can_dlc; i++)
355 cf->data[i] = priv->read_reg(priv, dreg++);
360 /* release receive buffer */
361 priv->write_reg(priv, REG_CMR, CMD_RRB);
365 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
366 dev->last_rx = jiffies;
369 stats->rx_bytes += cf->can_dlc;
372 static int sja1000_err(struct net_device *dev, uint8_t isrc, uint8_t status)
374 struct sja1000_priv *priv = netdev_priv(dev);
375 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
376 struct net_device_stats *stats = can_get_stats(dev);
378 struct net_device_stats *stats = &dev->stats;
380 struct can_frame *cf;
382 enum can_state state = priv->can.state;
385 skb = alloc_can_err_skb(dev, &cf);
389 if (isrc & IRQ_DOI) {
390 /* data overrun interrupt */
391 dev_dbg(ND2D(dev), "data overrun interrupt\n");
392 cf->can_id |= CAN_ERR_CRTL;
393 cf->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
394 stats->rx_over_errors++;
396 priv->write_reg(priv, REG_CMR, CMD_CDO); /* clear bit */
400 /* error warning interrupt */
401 dev_dbg(ND2D(dev), "error warning interrupt\n");
403 if (status & SR_BS) {
404 state = CAN_STATE_BUS_OFF;
405 cf->can_id |= CAN_ERR_BUSOFF;
407 } else if (status & SR_ES) {
408 state = CAN_STATE_ERROR_WARNING;
410 state = CAN_STATE_ERROR_ACTIVE;
412 if (isrc & IRQ_BEI) {
413 /* bus error interrupt */
414 priv->can.can_stats.bus_error++;
417 ecc = priv->read_reg(priv, REG_ECC);
419 cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
421 switch (ecc & ECC_MASK) {
423 cf->data[2] |= CAN_ERR_PROT_BIT;
426 cf->data[2] |= CAN_ERR_PROT_FORM;
429 cf->data[2] |= CAN_ERR_PROT_STUFF;
432 cf->data[2] |= CAN_ERR_PROT_UNSPEC;
433 cf->data[3] = ecc & ECC_SEG;
436 /* Error occured during transmission? */
437 if ((ecc & ECC_DIR) == 0)
438 cf->data[2] |= CAN_ERR_PROT_TX;
440 if (isrc & IRQ_EPI) {
441 /* error passive interrupt */
442 dev_dbg(ND2D(dev), "error passive interrupt\n");
444 state = CAN_STATE_ERROR_PASSIVE;
446 state = CAN_STATE_ERROR_ACTIVE;
448 if (isrc & IRQ_ALI) {
449 /* arbitration lost interrupt */
450 dev_dbg(ND2D(dev), "arbitration lost interrupt\n");
451 alc = priv->read_reg(priv, REG_ALC);
452 priv->can.can_stats.arbitration_lost++;
454 cf->can_id |= CAN_ERR_LOSTARB;
455 cf->data[0] = alc & 0x1f;
458 if (state != priv->can.state && (state == CAN_STATE_ERROR_WARNING ||
459 state == CAN_STATE_ERROR_PASSIVE)) {
460 uint8_t rxerr = priv->read_reg(priv, REG_RXERR);
461 uint8_t txerr = priv->read_reg(priv, REG_TXERR);
462 cf->can_id |= CAN_ERR_CRTL;
463 if (state == CAN_STATE_ERROR_WARNING) {
464 priv->can.can_stats.error_warning++;
465 cf->data[1] = (txerr > rxerr) ?
466 CAN_ERR_CRTL_TX_WARNING :
467 CAN_ERR_CRTL_RX_WARNING;
469 priv->can.can_stats.error_passive++;
470 cf->data[1] = (txerr > rxerr) ?
471 CAN_ERR_CRTL_TX_PASSIVE :
472 CAN_ERR_CRTL_RX_PASSIVE;
478 priv->can.state = state;
482 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
483 dev->last_rx = jiffies;
486 stats->rx_bytes += cf->can_dlc;
491 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,19)
492 irqreturn_t sja1000_interrupt(int irq, void *dev_id, struct pt_regs *regs)
494 irqreturn_t sja1000_interrupt(int irq, void *dev_id)
497 struct net_device *dev = (struct net_device *)dev_id;
498 struct sja1000_priv *priv = netdev_priv(dev);
499 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
500 struct net_device_stats *stats = can_get_stats(dev);
502 struct net_device_stats *stats = &dev->stats;
504 uint8_t isrc, status;
507 /* Shared interrupts and IRQ off? */
508 if (priv->read_reg(priv, REG_IER) == IRQ_OFF)
514 while ((isrc = priv->read_reg(priv, REG_IR)) && (n < SJA1000_MAX_IRQ)) {
516 status = priv->read_reg(priv, REG_SR);
519 dev_warn(ND2D(dev), "wakeup interrupt\n");
522 /* transmission complete interrupt */
523 stats->tx_bytes += priv->read_reg(priv, REG_FI) & 0xf;
525 can_get_echo_skb(dev, 0);
526 netif_wake_queue(dev);
529 /* receive interrupt */
530 while (status & SR_RBS) {
532 status = priv->read_reg(priv, REG_SR);
535 if (isrc & (IRQ_DOI | IRQ_EI | IRQ_BEI | IRQ_EPI | IRQ_ALI)) {
536 /* error interrupt */
537 if (sja1000_err(dev, isrc, status))
543 priv->post_irq(priv);
545 if (n >= SJA1000_MAX_IRQ)
546 dev_dbg(ND2D(dev), "%d messages handled in ISR", n);
548 return (n) ? IRQ_HANDLED : IRQ_NONE;
550 EXPORT_SYMBOL_GPL(sja1000_interrupt);
552 static int sja1000_open(struct net_device *dev)
554 struct sja1000_priv *priv = netdev_priv(dev);
557 /* set chip into reset mode */
561 err = open_candev(dev);
565 /* register interrupt handler, if not done by the device driver */
566 if (!(priv->flags & SJA1000_CUSTOM_IRQ_HANDLER)) {
567 err = request_irq(dev->irq, sja1000_interrupt, priv->irq_flags,
568 dev->name, (void *)dev);
575 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,23)
576 /* clear statistics */
577 memset(&priv->can.net_stats, 0, sizeof(priv->can.net_stats));
580 /* init and start chi */
582 priv->open_time = jiffies;
584 netif_start_queue(dev);
589 static int sja1000_close(struct net_device *dev)
591 struct sja1000_priv *priv = netdev_priv(dev);
593 netif_stop_queue(dev);
596 if (!(priv->flags & SJA1000_CUSTOM_IRQ_HANDLER))
597 free_irq(dev->irq, (void *)dev);
606 struct net_device *alloc_sja1000dev(int sizeof_priv)
608 struct net_device *dev;
609 struct sja1000_priv *priv;
611 dev = alloc_candev(sizeof(struct sja1000_priv) + sizeof_priv,
612 SJA1000_ECHO_SKB_MAX);
616 priv = netdev_priv(dev);
619 priv->can.bittiming_const = &sja1000_bittiming_const;
620 priv->can.do_set_bittiming = sja1000_set_bittiming;
621 priv->can.do_set_mode = sja1000_set_mode;
622 priv->can.do_get_berr_counter = sja1000_get_berr_counter;
623 priv->can.ctrlmode_supported = CAN_CTRLMODE_3_SAMPLES |
624 CAN_CTRLMODE_BERR_REPORTING;
627 priv->priv = (void *)priv + sizeof(struct sja1000_priv);
631 EXPORT_SYMBOL_GPL(alloc_sja1000dev);
633 void free_sja1000dev(struct net_device *dev)
637 EXPORT_SYMBOL_GPL(free_sja1000dev);
639 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
640 static const struct net_device_ops sja1000_netdev_ops = {
641 .ndo_open = sja1000_open,
642 .ndo_stop = sja1000_close,
643 .ndo_start_xmit = sja1000_start_xmit,
647 int register_sja1000dev(struct net_device *dev)
649 if (!sja1000_probe_chip(dev))
652 dev->flags |= IFF_ECHO; /* we support local echo */
653 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
654 dev->netdev_ops = &sja1000_netdev_ops;
656 dev->open = sja1000_open;
657 dev->stop = sja1000_close;
658 dev->hard_start_xmit = sja1000_start_xmit;
664 return register_candev(dev);
666 EXPORT_SYMBOL_GPL(register_sja1000dev);
668 void unregister_sja1000dev(struct net_device *dev)
671 unregister_candev(dev);
673 EXPORT_SYMBOL_GPL(unregister_sja1000dev);
675 static __init int sja1000_init(void)
677 printk(KERN_INFO "%s CAN netdevice driver\n", DRV_NAME);
682 module_init(sja1000_init);
684 static __exit void sja1000_exit(void)
686 printk(KERN_INFO "%s: driver removed\n", DRV_NAME);
689 module_exit(sja1000_exit);