2 * Janz MODULbus VMOD-ICAN3 CAN Interface Driver
4 * Copyright (c) 2010 Ira W. Snyder <iws@ovro.caltech.edu>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version.
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/interrupt.h>
15 #include <linux/delay.h>
16 #include <linux/platform_device.h>
18 #include <linux/netdevice.h>
19 #include <linux/can.h>
20 #include <linux/can/dev.h>
21 #include <linux/can/skb.h>
22 #include <linux/can/error.h>
24 #include <linux/mfd/janz.h>
27 /* the DPM has 64k of memory, organized into 256x 256 byte pages */
28 #define DPM_NUM_PAGES 256
29 #define DPM_PAGE_SIZE 256
30 #define DPM_PAGE_ADDR(p) ((p) * DPM_PAGE_SIZE)
32 /* JANZ ICAN3 "old-style" host interface queue page numbers */
33 #define QUEUE_OLD_CONTROL 0
34 #define QUEUE_OLD_RB0 1
35 #define QUEUE_OLD_RB1 2
36 #define QUEUE_OLD_WB0 3
37 #define QUEUE_OLD_WB1 4
39 /* Janz ICAN3 "old-style" host interface control registers */
40 #define MSYNC_PEER 0x00 /* ICAN only */
41 #define MSYNC_LOCL 0x01 /* host only */
42 #define TARGET_RUNNING 0x02
43 #define FIRMWARE_STAMP 0x60 /* big endian firmware stamp */
45 #define MSYNC_RB0 0x01
46 #define MSYNC_RB1 0x02
47 #define MSYNC_RBLW 0x04
48 #define MSYNC_RB_MASK (MSYNC_RB0 | MSYNC_RB1)
50 #define MSYNC_WB0 0x10
51 #define MSYNC_WB1 0x20
52 #define MSYNC_WBLW 0x40
53 #define MSYNC_WB_MASK (MSYNC_WB0 | MSYNC_WB1)
55 /* Janz ICAN3 "new-style" host interface queue page numbers */
56 #define QUEUE_TOHOST 5
57 #define QUEUE_FROMHOST_MID 6
58 #define QUEUE_FROMHOST_HIGH 7
59 #define QUEUE_FROMHOST_LOW 8
61 /* The first free page in the DPM is #9 */
62 #define DPM_FREE_START 9
64 /* Janz ICAN3 "new-style" and "fast" host interface descriptor flags */
65 #define DESC_VALID 0x80
66 #define DESC_WRAP 0x40
67 #define DESC_INTERRUPT 0x20
68 #define DESC_IVALID 0x10
69 #define DESC_LEN(len) (len)
71 /* Janz ICAN3 Firmware Messages */
72 #define MSG_CONNECTI 0x02
73 #define MSG_DISCONNECT 0x03
74 #define MSG_IDVERS 0x04
75 #define MSG_MSGLOST 0x05
76 #define MSG_NEWHOSTIF 0x08
77 #define MSG_INQUIRY 0x0a
78 #define MSG_SETAFILMASK 0x10
79 #define MSG_INITFDPMQUEUE 0x11
80 #define MSG_HWCONF 0x12
81 #define MSG_FMSGLOST 0x15
82 #define MSG_CEVTIND 0x37
83 #define MSG_CBTRREQ 0x41
84 #define MSG_COFFREQ 0x42
85 #define MSG_CONREQ 0x43
86 #define MSG_CCONFREQ 0x47
90 * Janz ICAN3 CAN Inquiry Message Types
92 * NOTE: there appears to be a firmware bug here. You must send
93 * NOTE: INQUIRY_STATUS and expect to receive an INQUIRY_EXTENDED
94 * NOTE: response. The controller never responds to a message with
95 * NOTE: the INQUIRY_EXTENDED subspec :(
97 #define INQUIRY_STATUS 0x00
98 #define INQUIRY_TERMINATION 0x01
99 #define INQUIRY_EXTENDED 0x04
101 /* Janz ICAN3 CAN Set Acceptance Filter Mask Message Types */
102 #define SETAFILMASK_REJECT 0x00
103 #define SETAFILMASK_FASTIF 0x02
105 /* Janz ICAN3 CAN Hardware Configuration Message Types */
106 #define HWCONF_TERMINATE_ON 0x01
107 #define HWCONF_TERMINATE_OFF 0x00
109 /* Janz ICAN3 CAN Event Indication Message Types */
110 #define CEVTIND_EI 0x01
111 #define CEVTIND_DOI 0x02
112 #define CEVTIND_LOST 0x04
113 #define CEVTIND_FULL 0x08
114 #define CEVTIND_BEI 0x10
116 #define CEVTIND_CHIP_SJA1000 0x02
118 #define ICAN3_BUSERR_QUOTA_MAX 255
120 /* Janz ICAN3 CAN Frame Conversion */
121 #define ICAN3_SNGL 0x02
122 #define ICAN3_ECHO 0x10
123 #define ICAN3_EFF_RTR 0x40
124 #define ICAN3_SFF_RTR 0x10
125 #define ICAN3_EFF 0x80
127 #define ICAN3_CAN_TYPE_MASK 0x0f
128 #define ICAN3_CAN_TYPE_SFF 0x00
129 #define ICAN3_CAN_TYPE_EFF 0x01
131 #define ICAN3_CAN_DLC_MASK 0x0f
134 * SJA1000 Status and Error Register Definitions
136 * Copied from drivers/net/can/sja1000/sja1000.h
139 /* status register content */
149 #define SR_CRIT (SR_BS|SR_ES)
156 #define ECC_FORM 0x40
157 #define ECC_STUFF 0x80
158 #define ECC_MASK 0xc0
160 /* Number of buffers for use in the "new-style" host interface */
161 #define ICAN3_NEW_BUFFERS 16
163 /* Number of buffers for use in the "fast" host interface */
164 #define ICAN3_TX_BUFFERS 512
165 #define ICAN3_RX_BUFFERS 1024
167 /* SJA1000 Clock Input */
168 #define ICAN3_CAN_CLOCK 8000000
170 /* Janz ICAN3 firmware types */
173 ICAN3_FWTYPE_CAL_CANOPEN,
177 #define DRV_NAME "janz-ican3"
179 /* DPM Control Registers -- starts at offset 0x100 in the MODULbus registers */
180 struct ican3_dpm_control {
181 /* window address register */
186 * Read access: clear interrupt from microcontroller
187 * Write access: send interrupt to microcontroller
192 /* write-only: reset all hardware on the module */
196 /* write-only: generate an interrupt to the TPU */
202 /* must be the first member */
205 /* CAN network device */
206 struct net_device *ndev;
207 struct napi_struct napi;
212 /* base address of registers and IRQ */
213 struct janz_cmodio_onboard_regs __iomem *ctrl;
214 struct ican3_dpm_control __iomem *dpmctrl;
218 /* CAN bus termination status */
219 struct completion termination_comp;
220 bool termination_enabled;
222 /* CAN bus error status registers */
223 struct completion buserror_comp;
224 struct can_berr_counter bec;
227 enum ican3_fwtype fwtype;
230 /* old and new style host interface */
233 /* queue for echo packets */
234 struct sk_buff_head echoq;
237 * Any function which changes the current DPM page must hold this
238 * lock while it is performing data accesses. This ensures that the
239 * function will not be preempted and end up reading data from a
240 * different DPM page than it expects.
244 /* new host interface */
249 /* fast host interface */
250 unsigned int fastrx_start;
251 unsigned int fastrx_num;
252 unsigned int fasttx_start;
253 unsigned int fasttx_num;
255 /* first free DPM page */
256 unsigned int free_page;
266 struct ican3_new_desc {
271 struct ican3_fast_desc {
277 /* write to the window basic address register */
278 static inline void ican3_set_page(struct ican3_dev *mod, unsigned int page)
280 BUG_ON(page >= DPM_NUM_PAGES);
281 iowrite8(page, &mod->dpmctrl->window_address);
285 * ICAN3 "old-style" host interface
289 * Receive a message from the ICAN3 "old-style" firmware interface
291 * LOCKING: must hold mod->lock
293 * returns 0 on success, -ENOMEM when no message exists
295 static int ican3_old_recv_msg(struct ican3_dev *mod, struct ican3_msg *msg)
297 unsigned int mbox, mbox_page;
300 /* get the MSYNC registers */
301 ican3_set_page(mod, QUEUE_OLD_CONTROL);
302 peer = ioread8(mod->dpm + MSYNC_PEER);
303 locl = ioread8(mod->dpm + MSYNC_LOCL);
306 if ((xord & MSYNC_RB_MASK) == 0x00) {
307 netdev_dbg(mod->ndev, "no mbox for reading\n");
311 /* find the first free mbox to read */
312 if ((xord & MSYNC_RB_MASK) == MSYNC_RB_MASK)
313 mbox = (xord & MSYNC_RBLW) ? MSYNC_RB0 : MSYNC_RB1;
315 mbox = (xord & MSYNC_RB0) ? MSYNC_RB0 : MSYNC_RB1;
317 /* copy the message */
318 mbox_page = (mbox == MSYNC_RB0) ? QUEUE_OLD_RB0 : QUEUE_OLD_RB1;
319 ican3_set_page(mod, mbox_page);
320 memcpy_fromio(msg, mod->dpm, sizeof(*msg));
323 * notify the firmware that the read buffer is available
324 * for it to fill again
328 ican3_set_page(mod, QUEUE_OLD_CONTROL);
329 iowrite8(locl, mod->dpm + MSYNC_LOCL);
334 * Send a message through the "old-style" firmware interface
336 * LOCKING: must hold mod->lock
338 * returns 0 on success, -ENOMEM when no free space exists
340 static int ican3_old_send_msg(struct ican3_dev *mod, struct ican3_msg *msg)
342 unsigned int mbox, mbox_page;
345 /* get the MSYNC registers */
346 ican3_set_page(mod, QUEUE_OLD_CONTROL);
347 peer = ioread8(mod->dpm + MSYNC_PEER);
348 locl = ioread8(mod->dpm + MSYNC_LOCL);
351 if ((xord & MSYNC_WB_MASK) == MSYNC_WB_MASK) {
352 netdev_err(mod->ndev, "no mbox for writing\n");
356 /* calculate a free mbox to use */
357 mbox = (xord & MSYNC_WB0) ? MSYNC_WB1 : MSYNC_WB0;
359 /* copy the message to the DPM */
360 mbox_page = (mbox == MSYNC_WB0) ? QUEUE_OLD_WB0 : QUEUE_OLD_WB1;
361 ican3_set_page(mod, mbox_page);
362 memcpy_toio(mod->dpm, msg, sizeof(*msg));
365 if (mbox == MSYNC_WB1)
368 ican3_set_page(mod, QUEUE_OLD_CONTROL);
369 iowrite8(locl, mod->dpm + MSYNC_LOCL);
374 * ICAN3 "new-style" Host Interface Setup
377 static void ican3_init_new_host_interface(struct ican3_dev *mod)
379 struct ican3_new_desc desc;
384 spin_lock_irqsave(&mod->lock, flags);
386 /* setup the internal datastructures for RX */
390 /* tohost queue descriptors are in page 5 */
391 ican3_set_page(mod, QUEUE_TOHOST);
394 /* initialize the tohost (rx) queue descriptors: pages 9-24 */
395 for (i = 0; i < ICAN3_NEW_BUFFERS; i++) {
396 desc.control = DESC_INTERRUPT | DESC_LEN(1); /* I L=1 */
397 desc.pointer = mod->free_page;
399 /* set wrap flag on last buffer */
400 if (i == ICAN3_NEW_BUFFERS - 1)
401 desc.control |= DESC_WRAP;
403 memcpy_toio(dst, &desc, sizeof(desc));
408 /* fromhost (tx) mid queue descriptors are in page 6 */
409 ican3_set_page(mod, QUEUE_FROMHOST_MID);
412 /* setup the internal datastructures for TX */
415 /* initialize the fromhost mid queue descriptors: pages 25-40 */
416 for (i = 0; i < ICAN3_NEW_BUFFERS; i++) {
417 desc.control = DESC_VALID | DESC_LEN(1); /* V L=1 */
418 desc.pointer = mod->free_page;
420 /* set wrap flag on last buffer */
421 if (i == ICAN3_NEW_BUFFERS - 1)
422 desc.control |= DESC_WRAP;
424 memcpy_toio(dst, &desc, sizeof(desc));
429 /* fromhost hi queue descriptors are in page 7 */
430 ican3_set_page(mod, QUEUE_FROMHOST_HIGH);
433 /* initialize only a single buffer in the fromhost hi queue (unused) */
434 desc.control = DESC_VALID | DESC_WRAP | DESC_LEN(1); /* VW L=1 */
435 desc.pointer = mod->free_page;
436 memcpy_toio(dst, &desc, sizeof(desc));
439 /* fromhost low queue descriptors are in page 8 */
440 ican3_set_page(mod, QUEUE_FROMHOST_LOW);
443 /* initialize only a single buffer in the fromhost low queue (unused) */
444 desc.control = DESC_VALID | DESC_WRAP | DESC_LEN(1); /* VW L=1 */
445 desc.pointer = mod->free_page;
446 memcpy_toio(dst, &desc, sizeof(desc));
449 spin_unlock_irqrestore(&mod->lock, flags);
453 * ICAN3 Fast Host Interface Setup
456 static void ican3_init_fast_host_interface(struct ican3_dev *mod)
458 struct ican3_fast_desc desc;
464 spin_lock_irqsave(&mod->lock, flags);
466 /* save the start recv page */
467 mod->fastrx_start = mod->free_page;
470 /* build a single fast tohost queue descriptor */
471 memset(&desc, 0, sizeof(desc));
475 /* build the tohost queue descriptor ring in memory */
477 for (i = 0; i < ICAN3_RX_BUFFERS; i++) {
479 /* set the wrap bit on the last buffer */
480 if (i == ICAN3_RX_BUFFERS - 1)
481 desc.control |= DESC_WRAP;
483 /* switch to the correct page */
484 ican3_set_page(mod, mod->free_page);
486 /* copy the descriptor to the DPM */
487 dst = mod->dpm + addr;
488 memcpy_toio(dst, &desc, sizeof(desc));
489 addr += sizeof(desc);
491 /* move to the next page if necessary */
492 if (addr >= DPM_PAGE_SIZE) {
498 /* make sure we page-align the next queue */
502 /* save the start xmit page */
503 mod->fasttx_start = mod->free_page;
506 /* build a single fast fromhost queue descriptor */
507 memset(&desc, 0, sizeof(desc));
508 desc.control = DESC_VALID;
511 /* build the fromhost queue descriptor ring in memory */
513 for (i = 0; i < ICAN3_TX_BUFFERS; i++) {
515 /* set the wrap bit on the last buffer */
516 if (i == ICAN3_TX_BUFFERS - 1)
517 desc.control |= DESC_WRAP;
519 /* switch to the correct page */
520 ican3_set_page(mod, mod->free_page);
522 /* copy the descriptor to the DPM */
523 dst = mod->dpm + addr;
524 memcpy_toio(dst, &desc, sizeof(desc));
525 addr += sizeof(desc);
527 /* move to the next page if necessary */
528 if (addr >= DPM_PAGE_SIZE) {
534 spin_unlock_irqrestore(&mod->lock, flags);
538 * ICAN3 "new-style" Host Interface Message Helpers
542 * LOCKING: must hold mod->lock
544 static int ican3_new_send_msg(struct ican3_dev *mod, struct ican3_msg *msg)
546 struct ican3_new_desc desc;
547 void __iomem *desc_addr = mod->dpm + (mod->tx_num * sizeof(desc));
549 /* switch to the fromhost mid queue, and read the buffer descriptor */
550 ican3_set_page(mod, QUEUE_FROMHOST_MID);
551 memcpy_fromio(&desc, desc_addr, sizeof(desc));
553 if (!(desc.control & DESC_VALID)) {
554 netdev_dbg(mod->ndev, "%s: no free buffers\n", __func__);
558 /* switch to the data page, copy the data */
559 ican3_set_page(mod, desc.pointer);
560 memcpy_toio(mod->dpm, msg, sizeof(*msg));
562 /* switch back to the descriptor, set the valid bit, write it back */
563 ican3_set_page(mod, QUEUE_FROMHOST_MID);
564 desc.control ^= DESC_VALID;
565 memcpy_toio(desc_addr, &desc, sizeof(desc));
567 /* update the tx number */
568 mod->tx_num = (desc.control & DESC_WRAP) ? 0 : (mod->tx_num + 1);
573 * LOCKING: must hold mod->lock
575 static int ican3_new_recv_msg(struct ican3_dev *mod, struct ican3_msg *msg)
577 struct ican3_new_desc desc;
578 void __iomem *desc_addr = mod->dpm + (mod->rx_num * sizeof(desc));
580 /* switch to the tohost queue, and read the buffer descriptor */
581 ican3_set_page(mod, QUEUE_TOHOST);
582 memcpy_fromio(&desc, desc_addr, sizeof(desc));
584 if (!(desc.control & DESC_VALID)) {
585 netdev_dbg(mod->ndev, "%s: no buffers to recv\n", __func__);
589 /* switch to the data page, copy the data */
590 ican3_set_page(mod, desc.pointer);
591 memcpy_fromio(msg, mod->dpm, sizeof(*msg));
593 /* switch back to the descriptor, toggle the valid bit, write it back */
594 ican3_set_page(mod, QUEUE_TOHOST);
595 desc.control ^= DESC_VALID;
596 memcpy_toio(desc_addr, &desc, sizeof(desc));
598 /* update the rx number */
599 mod->rx_num = (desc.control & DESC_WRAP) ? 0 : (mod->rx_num + 1);
604 * Message Send / Recv Helpers
607 static int ican3_send_msg(struct ican3_dev *mod, struct ican3_msg *msg)
612 spin_lock_irqsave(&mod->lock, flags);
614 if (mod->iftype == 0)
615 ret = ican3_old_send_msg(mod, msg);
617 ret = ican3_new_send_msg(mod, msg);
619 spin_unlock_irqrestore(&mod->lock, flags);
623 static int ican3_recv_msg(struct ican3_dev *mod, struct ican3_msg *msg)
628 spin_lock_irqsave(&mod->lock, flags);
630 if (mod->iftype == 0)
631 ret = ican3_old_recv_msg(mod, msg);
633 ret = ican3_new_recv_msg(mod, msg);
635 spin_unlock_irqrestore(&mod->lock, flags);
640 * Quick Pre-constructed Messages
643 static int ican3_msg_connect(struct ican3_dev *mod)
645 struct ican3_msg msg;
647 memset(&msg, 0, sizeof(msg));
648 msg.spec = MSG_CONNECTI;
649 msg.len = cpu_to_le16(0);
651 return ican3_send_msg(mod, &msg);
654 static int ican3_msg_disconnect(struct ican3_dev *mod)
656 struct ican3_msg msg;
658 memset(&msg, 0, sizeof(msg));
659 msg.spec = MSG_DISCONNECT;
660 msg.len = cpu_to_le16(0);
662 return ican3_send_msg(mod, &msg);
665 static int ican3_msg_newhostif(struct ican3_dev *mod)
667 struct ican3_msg msg;
670 memset(&msg, 0, sizeof(msg));
671 msg.spec = MSG_NEWHOSTIF;
672 msg.len = cpu_to_le16(0);
674 /* If we're not using the old interface, switching seems bogus */
675 WARN_ON(mod->iftype != 0);
677 ret = ican3_send_msg(mod, &msg);
681 /* mark the module as using the new host interface */
686 static int ican3_msg_fasthostif(struct ican3_dev *mod)
688 struct ican3_msg msg;
691 memset(&msg, 0, sizeof(msg));
692 msg.spec = MSG_INITFDPMQUEUE;
693 msg.len = cpu_to_le16(8);
695 /* write the tohost queue start address */
696 addr = DPM_PAGE_ADDR(mod->fastrx_start);
697 msg.data[0] = addr & 0xff;
698 msg.data[1] = (addr >> 8) & 0xff;
699 msg.data[2] = (addr >> 16) & 0xff;
700 msg.data[3] = (addr >> 24) & 0xff;
702 /* write the fromhost queue start address */
703 addr = DPM_PAGE_ADDR(mod->fasttx_start);
704 msg.data[4] = addr & 0xff;
705 msg.data[5] = (addr >> 8) & 0xff;
706 msg.data[6] = (addr >> 16) & 0xff;
707 msg.data[7] = (addr >> 24) & 0xff;
709 /* If we're not using the new interface yet, we cannot do this */
710 WARN_ON(mod->iftype != 1);
712 return ican3_send_msg(mod, &msg);
716 * Setup the CAN filter to either accept or reject all
717 * messages from the CAN bus.
719 static int ican3_set_id_filter(struct ican3_dev *mod, bool accept)
721 struct ican3_msg msg;
724 /* Standard Frame Format */
725 memset(&msg, 0, sizeof(msg));
726 msg.spec = MSG_SETAFILMASK;
727 msg.len = cpu_to_le16(5);
728 msg.data[0] = 0x00; /* IDLo LSB */
729 msg.data[1] = 0x00; /* IDLo MSB */
730 msg.data[2] = 0xff; /* IDHi LSB */
731 msg.data[3] = 0x07; /* IDHi MSB */
733 /* accept all frames for fast host if, or reject all frames */
734 msg.data[4] = accept ? SETAFILMASK_FASTIF : SETAFILMASK_REJECT;
736 ret = ican3_send_msg(mod, &msg);
740 /* Extended Frame Format */
741 memset(&msg, 0, sizeof(msg));
742 msg.spec = MSG_SETAFILMASK;
743 msg.len = cpu_to_le16(13);
744 msg.data[0] = 0; /* MUX = 0 */
745 msg.data[1] = 0x00; /* IDLo LSB */
748 msg.data[4] = 0x20; /* IDLo MSB */
749 msg.data[5] = 0xff; /* IDHi LSB */
752 msg.data[8] = 0x3f; /* IDHi MSB */
754 /* accept all frames for fast host if, or reject all frames */
755 msg.data[9] = accept ? SETAFILMASK_FASTIF : SETAFILMASK_REJECT;
757 return ican3_send_msg(mod, &msg);
761 * Bring the CAN bus online or offline
763 static int ican3_set_bus_state(struct ican3_dev *mod, bool on)
765 struct can_bittiming *bt = &mod->can.bittiming;
766 struct ican3_msg msg;
770 /* This algorithm was stolen from drivers/net/can/sja1000/sja1000.c */
771 /* The bittiming register command for the ICAN3 just sets the bit timing */
772 /* registers on the SJA1000 chip directly */
773 btr0 = ((bt->brp - 1) & 0x3f) | (((bt->sjw - 1) & 0x3) << 6);
774 btr1 = ((bt->prop_seg + bt->phase_seg1 - 1) & 0xf) |
775 (((bt->phase_seg2 - 1) & 0x7) << 4);
776 if (mod->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES)
779 if (mod->fwtype == ICAN3_FWTYPE_ICANOS) {
782 memset(&msg, 0, sizeof(msg));
783 msg.spec = MSG_CBTRREQ;
784 msg.len = cpu_to_le16(4);
790 res = ican3_send_msg(mod, &msg);
795 /* can-on/off request */
796 memset(&msg, 0, sizeof(msg));
797 msg.spec = on ? MSG_CONREQ : MSG_COFFREQ;
798 msg.len = cpu_to_le16(0);
800 return ican3_send_msg(mod, &msg);
802 } else if (mod->fwtype == ICAN3_FWTYPE_CAL_CANOPEN) {
803 memset(&msg, 0, sizeof(msg));
806 msg.len = cpu_to_le16(4);
812 msg.len = cpu_to_le16(2);
817 return ican3_send_msg(mod, &msg);
822 static int ican3_set_termination(struct ican3_dev *mod, bool on)
824 struct ican3_msg msg;
826 memset(&msg, 0, sizeof(msg));
827 msg.spec = MSG_HWCONF;
828 msg.len = cpu_to_le16(2);
830 msg.data[1] = on ? HWCONF_TERMINATE_ON : HWCONF_TERMINATE_OFF;
832 return ican3_send_msg(mod, &msg);
835 static int ican3_send_inquiry(struct ican3_dev *mod, u8 subspec)
837 struct ican3_msg msg;
839 memset(&msg, 0, sizeof(msg));
840 msg.spec = MSG_INQUIRY;
841 msg.len = cpu_to_le16(2);
842 msg.data[0] = subspec;
845 return ican3_send_msg(mod, &msg);
848 static int ican3_set_buserror(struct ican3_dev *mod, u8 quota)
850 struct ican3_msg msg;
852 memset(&msg, 0, sizeof(msg));
853 msg.spec = MSG_CCONFREQ;
854 msg.len = cpu_to_le16(2);
858 return ican3_send_msg(mod, &msg);
862 * ICAN3 to Linux CAN Frame Conversion
865 static void ican3_to_can_frame(struct ican3_dev *mod,
866 struct ican3_fast_desc *desc,
867 struct can_frame *cf)
869 if ((desc->command & ICAN3_CAN_TYPE_MASK) == ICAN3_CAN_TYPE_SFF) {
870 if (desc->data[1] & ICAN3_SFF_RTR)
871 cf->can_id |= CAN_RTR_FLAG;
873 cf->can_id |= desc->data[0] << 3;
874 cf->can_id |= (desc->data[1] & 0xe0) >> 5;
875 cf->can_dlc = get_can_dlc(desc->data[1] & ICAN3_CAN_DLC_MASK);
876 memcpy(cf->data, &desc->data[2], cf->can_dlc);
878 cf->can_dlc = get_can_dlc(desc->data[0] & ICAN3_CAN_DLC_MASK);
879 if (desc->data[0] & ICAN3_EFF_RTR)
880 cf->can_id |= CAN_RTR_FLAG;
882 if (desc->data[0] & ICAN3_EFF) {
883 cf->can_id |= CAN_EFF_FLAG;
884 cf->can_id |= desc->data[2] << 21; /* 28-21 */
885 cf->can_id |= desc->data[3] << 13; /* 20-13 */
886 cf->can_id |= desc->data[4] << 5; /* 12-5 */
887 cf->can_id |= (desc->data[5] & 0xf8) >> 3;
889 cf->can_id |= desc->data[2] << 3; /* 10-3 */
890 cf->can_id |= desc->data[3] >> 5; /* 2-0 */
893 memcpy(cf->data, &desc->data[6], cf->can_dlc);
897 static void can_frame_to_ican3(struct ican3_dev *mod,
898 struct can_frame *cf,
899 struct ican3_fast_desc *desc)
901 /* clear out any stale data in the descriptor */
902 memset(desc->data, 0, sizeof(desc->data));
904 /* we always use the extended format, with the ECHO flag set */
905 desc->command = ICAN3_CAN_TYPE_EFF;
906 desc->data[0] |= cf->can_dlc;
907 desc->data[1] |= ICAN3_ECHO;
909 /* support single transmission (no retries) mode */
910 if (mod->can.ctrlmode & CAN_CTRLMODE_ONE_SHOT)
911 desc->data[1] |= ICAN3_SNGL;
913 if (cf->can_id & CAN_RTR_FLAG)
914 desc->data[0] |= ICAN3_EFF_RTR;
916 /* pack the id into the correct places */
917 if (cf->can_id & CAN_EFF_FLAG) {
918 desc->data[0] |= ICAN3_EFF;
919 desc->data[2] = (cf->can_id & 0x1fe00000) >> 21; /* 28-21 */
920 desc->data[3] = (cf->can_id & 0x001fe000) >> 13; /* 20-13 */
921 desc->data[4] = (cf->can_id & 0x00001fe0) >> 5; /* 12-5 */
922 desc->data[5] = (cf->can_id & 0x0000001f) << 3; /* 4-0 */
924 desc->data[2] = (cf->can_id & 0x7F8) >> 3; /* bits 10-3 */
925 desc->data[3] = (cf->can_id & 0x007) << 5; /* bits 2-0 */
928 /* copy the data bits into the descriptor */
929 memcpy(&desc->data[6], cf->data, cf->can_dlc);
937 * Handle an ID + Version message response from the firmware. We never generate
938 * this message in production code, but it is very useful when debugging to be
939 * able to display this message.
941 static void ican3_handle_idvers(struct ican3_dev *mod, struct ican3_msg *msg)
943 netdev_dbg(mod->ndev, "IDVERS response: %s\n", msg->data);
946 static void ican3_handle_msglost(struct ican3_dev *mod, struct ican3_msg *msg)
948 struct net_device *dev = mod->ndev;
949 struct net_device_stats *stats = &dev->stats;
950 struct can_frame *cf;
954 * Report that communication messages with the microcontroller firmware
955 * are being lost. These are never CAN frames, so we do not generate an
956 * error frame for userspace
958 if (msg->spec == MSG_MSGLOST) {
959 netdev_err(mod->ndev, "lost %d control messages\n", msg->data[0]);
964 * Oops, this indicates that we have lost messages in the fast queue,
965 * which are exclusively CAN messages. Our driver isn't reading CAN
966 * frames fast enough.
968 * We'll pretend that the SJA1000 told us that it ran out of buffer
969 * space, because there is not a better message for this.
971 skb = alloc_can_err_skb(dev, &cf);
973 cf->can_id |= CAN_ERR_CRTL;
974 cf->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
975 stats->rx_over_errors++;
982 * Handle CAN Event Indication Messages from the firmware
984 * The ICAN3 firmware provides the values of some SJA1000 registers when it
985 * generates this message. The code below is largely copied from the
986 * drivers/net/can/sja1000/sja1000.c file, and adapted as necessary
988 static int ican3_handle_cevtind(struct ican3_dev *mod, struct ican3_msg *msg)
990 struct net_device *dev = mod->ndev;
991 struct net_device_stats *stats = &dev->stats;
992 enum can_state state = mod->can.state;
993 u8 isrc, ecc, status, rxerr, txerr;
994 struct can_frame *cf;
997 /* we can only handle the SJA1000 part */
998 if (msg->data[1] != CEVTIND_CHIP_SJA1000) {
999 netdev_err(mod->ndev, "unable to handle errors on non-SJA1000\n");
1003 /* check the message length for sanity */
1004 if (le16_to_cpu(msg->len) < 6) {
1005 netdev_err(mod->ndev, "error message too short\n");
1009 isrc = msg->data[0];
1011 status = msg->data[3];
1012 rxerr = msg->data[4];
1013 txerr = msg->data[5];
1016 * This hardware lacks any support other than bus error messages to
1017 * determine if packet transmission has failed.
1019 * When TX errors happen, one echo skb needs to be dropped from the
1020 * front of the queue.
1022 * A small bit of code is duplicated here and below, to avoid error
1023 * skb allocation when it will just be freed immediately.
1025 if (isrc == CEVTIND_BEI) {
1027 netdev_dbg(mod->ndev, "bus error interrupt\n");
1030 if (!(ecc & ECC_DIR)) {
1031 kfree_skb(skb_dequeue(&mod->echoq));
1038 * The controller automatically disables bus-error interrupts
1039 * and therefore we must re-enable them.
1041 ret = ican3_set_buserror(mod, 1);
1043 netdev_err(mod->ndev, "unable to re-enable bus-error\n");
1047 /* bus error reporting is off, return immediately */
1048 if (!(mod->can.ctrlmode & CAN_CTRLMODE_BERR_REPORTING))
1052 skb = alloc_can_err_skb(dev, &cf);
1056 /* data overrun interrupt */
1057 if (isrc == CEVTIND_DOI || isrc == CEVTIND_LOST) {
1058 netdev_dbg(mod->ndev, "data overrun interrupt\n");
1059 cf->can_id |= CAN_ERR_CRTL;
1060 cf->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
1061 stats->rx_over_errors++;
1065 /* error warning + passive interrupt */
1066 if (isrc == CEVTIND_EI) {
1067 netdev_dbg(mod->ndev, "error warning + passive interrupt\n");
1068 if (status & SR_BS) {
1069 state = CAN_STATE_BUS_OFF;
1070 cf->can_id |= CAN_ERR_BUSOFF;
1071 mod->can.can_stats.bus_off++;
1073 } else if (status & SR_ES) {
1074 if (rxerr >= 128 || txerr >= 128)
1075 state = CAN_STATE_ERROR_PASSIVE;
1077 state = CAN_STATE_ERROR_WARNING;
1079 state = CAN_STATE_ERROR_ACTIVE;
1083 /* bus error interrupt */
1084 if (isrc == CEVTIND_BEI) {
1085 mod->can.can_stats.bus_error++;
1086 cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
1088 switch (ecc & ECC_MASK) {
1090 cf->data[2] |= CAN_ERR_PROT_BIT;
1093 cf->data[2] |= CAN_ERR_PROT_FORM;
1096 cf->data[2] |= CAN_ERR_PROT_STUFF;
1099 cf->data[2] |= CAN_ERR_PROT_UNSPEC;
1100 cf->data[3] = ecc & ECC_SEG;
1104 if (!(ecc & ECC_DIR))
1105 cf->data[2] |= CAN_ERR_PROT_TX;
1107 cf->data[6] = txerr;
1108 cf->data[7] = rxerr;
1111 if (state != mod->can.state && (state == CAN_STATE_ERROR_WARNING ||
1112 state == CAN_STATE_ERROR_PASSIVE)) {
1113 cf->can_id |= CAN_ERR_CRTL;
1114 if (state == CAN_STATE_ERROR_WARNING) {
1115 mod->can.can_stats.error_warning++;
1116 cf->data[1] = (txerr > rxerr) ?
1117 CAN_ERR_CRTL_TX_WARNING :
1118 CAN_ERR_CRTL_RX_WARNING;
1120 mod->can.can_stats.error_passive++;
1121 cf->data[1] = (txerr > rxerr) ?
1122 CAN_ERR_CRTL_TX_PASSIVE :
1123 CAN_ERR_CRTL_RX_PASSIVE;
1126 cf->data[6] = txerr;
1127 cf->data[7] = rxerr;
1130 mod->can.state = state;
1135 static void ican3_handle_inquiry(struct ican3_dev *mod, struct ican3_msg *msg)
1137 switch (msg->data[0]) {
1138 case INQUIRY_STATUS:
1139 case INQUIRY_EXTENDED:
1140 mod->bec.rxerr = msg->data[5];
1141 mod->bec.txerr = msg->data[6];
1142 complete(&mod->buserror_comp);
1144 case INQUIRY_TERMINATION:
1145 mod->termination_enabled = msg->data[6] & HWCONF_TERMINATE_ON;
1146 complete(&mod->termination_comp);
1149 netdev_err(mod->ndev, "received an unknown inquiry response\n");
1154 static void ican3_handle_unknown_message(struct ican3_dev *mod,
1155 struct ican3_msg *msg)
1157 netdev_warn(mod->ndev, "received unknown message: spec 0x%.2x length %d\n",
1158 msg->spec, le16_to_cpu(msg->len));
1162 * Handle a control message from the firmware
1164 static void ican3_handle_message(struct ican3_dev *mod, struct ican3_msg *msg)
1166 netdev_dbg(mod->ndev, "%s: modno %d spec 0x%.2x len %d bytes\n", __func__,
1167 mod->num, msg->spec, le16_to_cpu(msg->len));
1169 switch (msg->spec) {
1171 ican3_handle_idvers(mod, msg);
1175 ican3_handle_msglost(mod, msg);
1178 ican3_handle_cevtind(mod, msg);
1181 ican3_handle_inquiry(mod, msg);
1184 ican3_handle_unknown_message(mod, msg);
1190 * The ican3 needs to store all echo skbs, and therefore cannot
1191 * use the generic infrastructure for this.
1193 static void ican3_put_echo_skb(struct ican3_dev *mod, struct sk_buff *skb)
1195 skb = can_create_echo_skb(skb);
1199 /* save this skb for tx interrupt echo handling */
1200 skb_queue_tail(&mod->echoq, skb);
1203 static unsigned int ican3_get_echo_skb(struct ican3_dev *mod)
1205 struct sk_buff *skb = skb_dequeue(&mod->echoq);
1206 struct can_frame *cf;
1209 /* this should never trigger unless there is a driver bug */
1211 netdev_err(mod->ndev, "BUG: echo skb not occupied\n");
1215 cf = (struct can_frame *)skb->data;
1218 /* check flag whether this packet has to be looped back */
1219 if (skb->pkt_type != PACKET_LOOPBACK) {
1224 skb->protocol = htons(ETH_P_CAN);
1225 skb->pkt_type = PACKET_BROADCAST;
1226 skb->ip_summed = CHECKSUM_UNNECESSARY;
1227 skb->dev = mod->ndev;
1228 netif_receive_skb(skb);
1233 * Compare an skb with an existing echo skb
1235 * This function will be used on devices which have a hardware loopback.
1236 * On these devices, this function can be used to compare a received skb
1237 * with the saved echo skbs so that the hardware echo skb can be dropped.
1239 * Returns true if the skb's are identical, false otherwise.
1241 static bool ican3_echo_skb_matches(struct ican3_dev *mod, struct sk_buff *skb)
1243 struct can_frame *cf = (struct can_frame *)skb->data;
1244 struct sk_buff *echo_skb = skb_peek(&mod->echoq);
1245 struct can_frame *echo_cf;
1250 echo_cf = (struct can_frame *)echo_skb->data;
1251 if (cf->can_id != echo_cf->can_id)
1254 if (cf->can_dlc != echo_cf->can_dlc)
1257 return memcmp(cf->data, echo_cf->data, cf->can_dlc) == 0;
1261 * Check that there is room in the TX ring to transmit another skb
1263 * LOCKING: must hold mod->lock
1265 static bool ican3_txok(struct ican3_dev *mod)
1267 struct ican3_fast_desc __iomem *desc;
1270 /* check that we have echo queue space */
1271 if (skb_queue_len(&mod->echoq) >= ICAN3_TX_BUFFERS)
1274 /* copy the control bits of the descriptor */
1275 ican3_set_page(mod, mod->fasttx_start + (mod->fasttx_num / 16));
1276 desc = mod->dpm + ((mod->fasttx_num % 16) * sizeof(*desc));
1277 control = ioread8(&desc->control);
1279 /* if the control bits are not valid, then we have no more space */
1280 if (!(control & DESC_VALID))
1287 * Receive one CAN frame from the hardware
1289 * CONTEXT: must be called from user context
1291 static int ican3_recv_skb(struct ican3_dev *mod)
1293 struct net_device *ndev = mod->ndev;
1294 struct net_device_stats *stats = &ndev->stats;
1295 struct ican3_fast_desc desc;
1296 void __iomem *desc_addr;
1297 struct can_frame *cf;
1298 struct sk_buff *skb;
1299 unsigned long flags;
1301 spin_lock_irqsave(&mod->lock, flags);
1303 /* copy the whole descriptor */
1304 ican3_set_page(mod, mod->fastrx_start + (mod->fastrx_num / 16));
1305 desc_addr = mod->dpm + ((mod->fastrx_num % 16) * sizeof(desc));
1306 memcpy_fromio(&desc, desc_addr, sizeof(desc));
1308 spin_unlock_irqrestore(&mod->lock, flags);
1310 /* check that we actually have a CAN frame */
1311 if (!(desc.control & DESC_VALID))
1314 /* allocate an skb */
1315 skb = alloc_can_skb(ndev, &cf);
1316 if (unlikely(skb == NULL)) {
1317 stats->rx_dropped++;
1321 /* convert the ICAN3 frame into Linux CAN format */
1322 ican3_to_can_frame(mod, &desc, cf);
1325 * If this is an ECHO frame received from the hardware loopback
1326 * feature, use the skb saved in the ECHO stack instead. This allows
1327 * the Linux CAN core to support CAN_RAW_RECV_OWN_MSGS correctly.
1329 * Since this is a confirmation of a successfully transmitted packet
1330 * sent from this host, update the transmit statistics.
1332 * Also, the netdevice queue needs to be allowed to send packets again.
1334 if (ican3_echo_skb_matches(mod, skb)) {
1335 stats->tx_packets++;
1336 stats->tx_bytes += ican3_get_echo_skb(mod);
1341 /* update statistics, receive the skb */
1342 stats->rx_packets++;
1343 stats->rx_bytes += cf->can_dlc;
1344 netif_receive_skb(skb);
1347 /* toggle the valid bit and return the descriptor to the ring */
1348 desc.control ^= DESC_VALID;
1350 spin_lock_irqsave(&mod->lock, flags);
1352 ican3_set_page(mod, mod->fastrx_start + (mod->fastrx_num / 16));
1353 memcpy_toio(desc_addr, &desc, 1);
1355 /* update the next buffer pointer */
1356 mod->fastrx_num = (desc.control & DESC_WRAP) ? 0
1357 : (mod->fastrx_num + 1);
1359 /* there are still more buffers to process */
1360 spin_unlock_irqrestore(&mod->lock, flags);
1364 static int ican3_napi(struct napi_struct *napi, int budget)
1366 struct ican3_dev *mod = container_of(napi, struct ican3_dev, napi);
1367 unsigned long flags;
1371 /* process all communication messages */
1373 struct ican3_msg uninitialized_var(msg);
1374 ret = ican3_recv_msg(mod, &msg);
1378 ican3_handle_message(mod, &msg);
1381 /* process all CAN frames from the fast interface */
1382 while (received < budget) {
1383 ret = ican3_recv_skb(mod);
1390 /* We have processed all packets that the adapter had, but it
1391 * was less than our budget, stop polling */
1392 if (received < budget)
1393 napi_complete(napi);
1395 spin_lock_irqsave(&mod->lock, flags);
1397 /* Wake up the transmit queue if necessary */
1398 if (netif_queue_stopped(mod->ndev) && ican3_txok(mod))
1399 netif_wake_queue(mod->ndev);
1401 spin_unlock_irqrestore(&mod->lock, flags);
1403 /* re-enable interrupt generation */
1404 iowrite8(1 << mod->num, &mod->ctrl->int_enable);
1408 static irqreturn_t ican3_irq(int irq, void *dev_id)
1410 struct ican3_dev *mod = dev_id;
1414 * The interrupt status register on this device reports interrupts
1415 * as zeroes instead of using ones like most other devices
1417 stat = ioread8(&mod->ctrl->int_disable) & (1 << mod->num);
1418 if (stat == (1 << mod->num))
1421 /* clear the MODULbus interrupt from the microcontroller */
1422 ioread8(&mod->dpmctrl->interrupt);
1424 /* disable interrupt generation, schedule the NAPI poller */
1425 iowrite8(1 << mod->num, &mod->ctrl->int_disable);
1426 napi_schedule(&mod->napi);
1431 * Firmware reset, startup, and shutdown
1435 * Reset an ICAN module to its power-on state
1437 * CONTEXT: no network device registered
1439 static int ican3_reset_module(struct ican3_dev *mod)
1441 unsigned long start;
1444 /* disable interrupts so no more work is scheduled */
1445 iowrite8(1 << mod->num, &mod->ctrl->int_disable);
1447 /* the first unallocated page in the DPM is #9 */
1448 mod->free_page = DPM_FREE_START;
1450 ican3_set_page(mod, QUEUE_OLD_CONTROL);
1451 runold = ioread8(mod->dpm + TARGET_RUNNING);
1453 /* reset the module */
1454 iowrite8(0x00, &mod->dpmctrl->hwreset);
1456 /* wait until the module has finished resetting and is running */
1459 ican3_set_page(mod, QUEUE_OLD_CONTROL);
1460 runnew = ioread8(mod->dpm + TARGET_RUNNING);
1461 if (runnew == (runold ^ 0xff))
1465 } while (time_before(jiffies, start + HZ / 2));
1467 netdev_err(mod->ndev, "failed to reset CAN module\n");
1471 static void ican3_shutdown_module(struct ican3_dev *mod)
1473 ican3_msg_disconnect(mod);
1474 ican3_reset_module(mod);
1478 * Startup an ICAN module, bringing it into fast mode
1480 static int ican3_startup_module(struct ican3_dev *mod)
1484 ret = ican3_reset_module(mod);
1486 netdev_err(mod->ndev, "unable to reset module\n");
1490 /* detect firmware */
1491 memcpy_fromio(mod->fwinfo, mod->dpm + FIRMWARE_STAMP, sizeof(mod->fwinfo) - 1);
1492 if (strncmp(mod->fwinfo, "JANZ-ICAN3", 10)) {
1493 netdev_err(mod->ndev, "ICAN3 not detected (found %s)\n", mod->fwinfo);
1496 if (strstr(mod->fwinfo, "CAL/CANopen"))
1497 mod->fwtype = ICAN3_FWTYPE_CAL_CANOPEN;
1499 mod->fwtype = ICAN3_FWTYPE_ICANOS;
1501 /* re-enable interrupts so we can send messages */
1502 iowrite8(1 << mod->num, &mod->ctrl->int_enable);
1504 ret = ican3_msg_connect(mod);
1506 netdev_err(mod->ndev, "unable to connect to module\n");
1510 ican3_init_new_host_interface(mod);
1511 ret = ican3_msg_newhostif(mod);
1513 netdev_err(mod->ndev, "unable to switch to new-style interface\n");
1517 /* default to "termination on" */
1518 ret = ican3_set_termination(mod, true);
1520 netdev_err(mod->ndev, "unable to enable termination\n");
1524 /* default to "bus errors enabled" */
1525 ret = ican3_set_buserror(mod, 1);
1527 netdev_err(mod->ndev, "unable to set bus-error\n");
1531 ican3_init_fast_host_interface(mod);
1532 ret = ican3_msg_fasthostif(mod);
1534 netdev_err(mod->ndev, "unable to switch to fast host interface\n");
1538 ret = ican3_set_id_filter(mod, true);
1540 netdev_err(mod->ndev, "unable to set acceptance filter\n");
1548 * CAN Network Device
1551 static int ican3_open(struct net_device *ndev)
1553 struct ican3_dev *mod = netdev_priv(ndev);
1556 /* open the CAN layer */
1557 ret = open_candev(ndev);
1559 netdev_err(mod->ndev, "unable to start CAN layer\n");
1563 /* bring the bus online */
1564 ret = ican3_set_bus_state(mod, true);
1566 netdev_err(mod->ndev, "unable to set bus-on\n");
1571 /* start up the network device */
1572 mod->can.state = CAN_STATE_ERROR_ACTIVE;
1573 netif_start_queue(ndev);
1578 static int ican3_stop(struct net_device *ndev)
1580 struct ican3_dev *mod = netdev_priv(ndev);
1583 /* stop the network device xmit routine */
1584 netif_stop_queue(ndev);
1585 mod->can.state = CAN_STATE_STOPPED;
1587 /* bring the bus offline, stop receiving packets */
1588 ret = ican3_set_bus_state(mod, false);
1590 netdev_err(mod->ndev, "unable to set bus-off\n");
1594 /* drop all outstanding echo skbs */
1595 skb_queue_purge(&mod->echoq);
1597 /* close the CAN layer */
1602 static int ican3_xmit(struct sk_buff *skb, struct net_device *ndev)
1604 struct ican3_dev *mod = netdev_priv(ndev);
1605 struct can_frame *cf = (struct can_frame *)skb->data;
1606 struct ican3_fast_desc desc;
1607 void __iomem *desc_addr;
1608 unsigned long flags;
1610 if (can_dropped_invalid_skb(ndev, skb))
1611 return NETDEV_TX_OK;
1613 spin_lock_irqsave(&mod->lock, flags);
1615 /* check that we can actually transmit */
1616 if (!ican3_txok(mod)) {
1617 netdev_err(mod->ndev, "BUG: no free descriptors\n");
1618 spin_unlock_irqrestore(&mod->lock, flags);
1619 return NETDEV_TX_BUSY;
1622 /* copy the control bits of the descriptor */
1623 ican3_set_page(mod, mod->fasttx_start + (mod->fasttx_num / 16));
1624 desc_addr = mod->dpm + ((mod->fasttx_num % 16) * sizeof(desc));
1625 memset(&desc, 0, sizeof(desc));
1626 memcpy_fromio(&desc, desc_addr, 1);
1628 /* convert the Linux CAN frame into ICAN3 format */
1629 can_frame_to_ican3(mod, cf, &desc);
1632 * This hardware doesn't have TX-done notifications, so we'll try and
1633 * emulate it the best we can using ECHO skbs. Add the skb to the ECHO
1634 * stack. Upon packet reception, check if the ECHO skb and received
1635 * skb match, and use that to wake the queue.
1637 ican3_put_echo_skb(mod, skb);
1640 * the programming manual says that you must set the IVALID bit, then
1641 * interrupt, then set the valid bit. Quite weird, but it seems to be
1642 * required for this to work
1644 desc.control |= DESC_IVALID;
1645 memcpy_toio(desc_addr, &desc, sizeof(desc));
1647 /* generate a MODULbus interrupt to the microcontroller */
1648 iowrite8(0x01, &mod->dpmctrl->interrupt);
1650 desc.control ^= DESC_VALID;
1651 memcpy_toio(desc_addr, &desc, sizeof(desc));
1653 /* update the next buffer pointer */
1654 mod->fasttx_num = (desc.control & DESC_WRAP) ? 0
1655 : (mod->fasttx_num + 1);
1657 /* if there is no free descriptor space, stop the transmit queue */
1658 if (!ican3_txok(mod))
1659 netif_stop_queue(ndev);
1661 spin_unlock_irqrestore(&mod->lock, flags);
1662 return NETDEV_TX_OK;
1665 static const struct net_device_ops ican3_netdev_ops = {
1666 .ndo_open = ican3_open,
1667 .ndo_stop = ican3_stop,
1668 .ndo_start_xmit = ican3_xmit,
1669 .ndo_change_mtu = can_change_mtu,
1673 * Low-level CAN Device
1676 /* This structure was stolen from drivers/net/can/sja1000/sja1000.c */
1677 static const struct can_bittiming_const ican3_bittiming_const = {
1689 static int ican3_set_mode(struct net_device *ndev, enum can_mode mode)
1691 struct ican3_dev *mod = netdev_priv(ndev);
1694 if (mode != CAN_MODE_START)
1697 /* bring the bus online */
1698 ret = ican3_set_bus_state(mod, true);
1700 netdev_err(ndev, "unable to set bus-on\n");
1704 /* start up the network device */
1705 mod->can.state = CAN_STATE_ERROR_ACTIVE;
1707 if (netif_queue_stopped(ndev))
1708 netif_wake_queue(ndev);
1713 static int ican3_get_berr_counter(const struct net_device *ndev,
1714 struct can_berr_counter *bec)
1716 struct ican3_dev *mod = netdev_priv(ndev);
1719 ret = ican3_send_inquiry(mod, INQUIRY_STATUS);
1723 if (!wait_for_completion_timeout(&mod->buserror_comp, HZ)) {
1724 netdev_info(mod->ndev, "%s timed out\n", __func__);
1728 bec->rxerr = mod->bec.rxerr;
1729 bec->txerr = mod->bec.txerr;
1737 static ssize_t ican3_sysfs_show_term(struct device *dev,
1738 struct device_attribute *attr,
1741 struct ican3_dev *mod = netdev_priv(to_net_dev(dev));
1744 ret = ican3_send_inquiry(mod, INQUIRY_TERMINATION);
1748 if (!wait_for_completion_timeout(&mod->termination_comp, HZ)) {
1749 netdev_info(mod->ndev, "%s timed out\n", __func__);
1753 return snprintf(buf, PAGE_SIZE, "%u\n", mod->termination_enabled);
1756 static ssize_t ican3_sysfs_set_term(struct device *dev,
1757 struct device_attribute *attr,
1758 const char *buf, size_t count)
1760 struct ican3_dev *mod = netdev_priv(to_net_dev(dev));
1761 unsigned long enable;
1764 if (kstrtoul(buf, 0, &enable))
1767 ret = ican3_set_termination(mod, enable);
1774 static ssize_t ican3_sysfs_show_fwinfo(struct device *dev,
1775 struct device_attribute *attr,
1778 struct ican3_dev *mod = netdev_priv(to_net_dev(dev));
1780 return scnprintf(buf, PAGE_SIZE, "%s\n", mod->fwinfo);
1783 static DEVICE_ATTR(termination, S_IWUSR | S_IRUGO, ican3_sysfs_show_term,
1784 ican3_sysfs_set_term);
1785 static DEVICE_ATTR(fwinfo, S_IRUSR | S_IRUGO, ican3_sysfs_show_fwinfo, NULL);
1787 static struct attribute *ican3_sysfs_attrs[] = {
1788 &dev_attr_termination.attr,
1789 &dev_attr_fwinfo.attr,
1793 static struct attribute_group ican3_sysfs_attr_group = {
1794 .attrs = ican3_sysfs_attrs,
1801 static int ican3_probe(struct platform_device *pdev)
1803 struct janz_platform_data *pdata;
1804 struct net_device *ndev;
1805 struct ican3_dev *mod;
1806 struct resource *res;
1810 pdata = dev_get_platdata(&pdev->dev);
1814 dev_dbg(&pdev->dev, "probe: module number %d\n", pdata->modno);
1816 /* save the struct device for printing */
1819 /* allocate the CAN device and private data */
1820 ndev = alloc_candev(sizeof(*mod), 0);
1822 dev_err(dev, "unable to allocate CANdev\n");
1827 platform_set_drvdata(pdev, ndev);
1828 mod = netdev_priv(ndev);
1830 mod->num = pdata->modno;
1831 netif_napi_add(ndev, &mod->napi, ican3_napi, ICAN3_RX_BUFFERS);
1832 skb_queue_head_init(&mod->echoq);
1833 spin_lock_init(&mod->lock);
1834 init_completion(&mod->termination_comp);
1835 init_completion(&mod->buserror_comp);
1837 /* setup device-specific sysfs attributes */
1838 ndev->sysfs_groups[0] = &ican3_sysfs_attr_group;
1840 /* the first unallocated page in the DPM is 9 */
1841 mod->free_page = DPM_FREE_START;
1843 ndev->netdev_ops = &ican3_netdev_ops;
1844 ndev->flags |= IFF_ECHO;
1845 SET_NETDEV_DEV(ndev, &pdev->dev);
1847 mod->can.clock.freq = ICAN3_CAN_CLOCK;
1848 mod->can.bittiming_const = &ican3_bittiming_const;
1849 mod->can.do_set_mode = ican3_set_mode;
1850 mod->can.do_get_berr_counter = ican3_get_berr_counter;
1851 mod->can.ctrlmode_supported = CAN_CTRLMODE_3_SAMPLES
1852 | CAN_CTRLMODE_BERR_REPORTING
1853 | CAN_CTRLMODE_ONE_SHOT;
1855 /* find our IRQ number */
1856 mod->irq = platform_get_irq(pdev, 0);
1858 dev_err(dev, "IRQ line not found\n");
1863 ndev->irq = mod->irq;
1865 /* get access to the MODULbus registers for this module */
1866 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1868 dev_err(dev, "MODULbus registers not found\n");
1873 mod->dpm = ioremap(res->start, resource_size(res));
1875 dev_err(dev, "MODULbus registers not ioremap\n");
1880 mod->dpmctrl = mod->dpm + DPM_PAGE_SIZE;
1882 /* get access to the control registers for this module */
1883 res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
1885 dev_err(dev, "CONTROL registers not found\n");
1887 goto out_iounmap_dpm;
1890 mod->ctrl = ioremap(res->start, resource_size(res));
1892 dev_err(dev, "CONTROL registers not ioremap\n");
1894 goto out_iounmap_dpm;
1897 /* disable our IRQ, then hookup the IRQ handler */
1898 iowrite8(1 << mod->num, &mod->ctrl->int_disable);
1899 ret = request_irq(mod->irq, ican3_irq, IRQF_SHARED, DRV_NAME, mod);
1901 dev_err(dev, "unable to request IRQ\n");
1902 goto out_iounmap_ctrl;
1905 /* reset and initialize the CAN controller into fast mode */
1906 napi_enable(&mod->napi);
1907 ret = ican3_startup_module(mod);
1909 dev_err(dev, "%s: unable to start CANdev\n", __func__);
1913 /* register with the Linux CAN layer */
1914 ret = register_candev(ndev);
1916 dev_err(dev, "%s: unable to register CANdev\n", __func__);
1920 netdev_info(mod->ndev, "module %d: registered CAN device\n", pdata->modno);
1924 napi_disable(&mod->napi);
1925 iowrite8(1 << mod->num, &mod->ctrl->int_disable);
1926 free_irq(mod->irq, mod);
1937 static int ican3_remove(struct platform_device *pdev)
1939 struct net_device *ndev = platform_get_drvdata(pdev);
1940 struct ican3_dev *mod = netdev_priv(ndev);
1942 /* unregister the netdevice, stop interrupts */
1943 unregister_netdev(ndev);
1944 napi_disable(&mod->napi);
1945 iowrite8(1 << mod->num, &mod->ctrl->int_disable);
1946 free_irq(mod->irq, mod);
1948 /* put the module into reset */
1949 ican3_shutdown_module(mod);
1951 /* unmap all registers */
1960 static struct platform_driver ican3_driver = {
1964 .probe = ican3_probe,
1965 .remove = ican3_remove,
1968 module_platform_driver(ican3_driver);
1970 MODULE_AUTHOR("Ira W. Snyder <iws@ovro.caltech.edu>");
1971 MODULE_DESCRIPTION("Janz MODULbus VMOD-ICAN3 Driver");
1972 MODULE_LICENSE("GPL");
1973 MODULE_ALIAS("platform:janz-ican3");