2 * This program is free software; you can redistribute it and/or
3 * modify it under the terms of the GNU General Public License as
4 * published by the Free Software Foundation version 2.
6 * Parts of this driver are based on the following:
7 * - Kvaser linux leaf driver (version 4.78)
8 * - CAN driver for esd CAN-USB/2
10 * Copyright (C) 2002-2006 KVASER AB, Sweden. All rights reserved.
11 * Copyright (C) 2010 Matthias Fuchs <matthias.fuchs@esd.eu>, esd gmbh
12 * Copyright (C) 2012 Olivier Sobrie <olivier@sobrie.be>
15 #include <linux/init.h>
16 #include <linux/completion.h>
17 #include <linux/module.h>
18 #include <linux/netdevice.h>
19 #include <linux/usb.h>
21 #include <linux/can.h>
22 #include <linux/can/dev.h>
23 #include <linux/can/error.h>
25 #define MAX_TX_URBS 16
27 #define START_TIMEOUT 1000 /* msecs */
28 #define STOP_TIMEOUT 1000 /* msecs */
29 #define USB_SEND_TIMEOUT 1000 /* msecs */
30 #define USB_RECV_TIMEOUT 1000 /* msecs */
31 #define RX_BUFFER_SIZE 3072
32 #define CAN_USB_CLOCK 8000000
33 #define MAX_NET_DEVICES 3
35 /* Kvaser USB devices */
36 #define KVASER_VENDOR_ID 0x0bfd
37 #define USB_LEAF_DEVEL_PRODUCT_ID 10
38 #define USB_LEAF_LITE_PRODUCT_ID 11
39 #define USB_LEAF_PRO_PRODUCT_ID 12
40 #define USB_LEAF_SPRO_PRODUCT_ID 14
41 #define USB_LEAF_PRO_LS_PRODUCT_ID 15
42 #define USB_LEAF_PRO_SWC_PRODUCT_ID 16
43 #define USB_LEAF_PRO_LIN_PRODUCT_ID 17
44 #define USB_LEAF_SPRO_LS_PRODUCT_ID 18
45 #define USB_LEAF_SPRO_SWC_PRODUCT_ID 19
46 #define USB_MEMO2_DEVEL_PRODUCT_ID 22
47 #define USB_MEMO2_HSHS_PRODUCT_ID 23
48 #define USB_UPRO_HSHS_PRODUCT_ID 24
49 #define USB_LEAF_LITE_GI_PRODUCT_ID 25
50 #define USB_LEAF_PRO_OBDII_PRODUCT_ID 26
51 #define USB_MEMO2_HSLS_PRODUCT_ID 27
52 #define USB_LEAF_LITE_CH_PRODUCT_ID 28
53 #define USB_BLACKBIRD_SPRO_PRODUCT_ID 29
54 #define USB_OEM_MERCURY_PRODUCT_ID 34
55 #define USB_OEM_LEAF_PRODUCT_ID 35
56 #define USB_CAN_R_PRODUCT_ID 39
58 /* USB devices features */
59 #define KVASER_HAS_SILENT_MODE BIT(0)
60 #define KVASER_HAS_TXRX_ERRORS BIT(1)
62 /* Message header size */
63 #define MSG_HEADER_LEN 2
65 /* Can message flags */
66 #define MSG_FLAG_ERROR_FRAME BIT(0)
67 #define MSG_FLAG_OVERRUN BIT(1)
68 #define MSG_FLAG_NERR BIT(2)
69 #define MSG_FLAG_WAKEUP BIT(3)
70 #define MSG_FLAG_REMOTE_FRAME BIT(4)
71 #define MSG_FLAG_RESERVED BIT(5)
72 #define MSG_FLAG_TX_ACK BIT(6)
73 #define MSG_FLAG_TX_REQUEST BIT(7)
76 #define M16C_STATE_BUS_RESET BIT(0)
77 #define M16C_STATE_BUS_ERROR BIT(4)
78 #define M16C_STATE_BUS_PASSIVE BIT(5)
79 #define M16C_STATE_BUS_OFF BIT(6)
82 #define CMD_RX_STD_MESSAGE 12
83 #define CMD_TX_STD_MESSAGE 13
84 #define CMD_RX_EXT_MESSAGE 14
85 #define CMD_TX_EXT_MESSAGE 15
86 #define CMD_SET_BUS_PARAMS 16
87 #define CMD_GET_BUS_PARAMS 17
88 #define CMD_GET_BUS_PARAMS_REPLY 18
89 #define CMD_GET_CHIP_STATE 19
90 #define CMD_CHIP_STATE_EVENT 20
91 #define CMD_SET_CTRL_MODE 21
92 #define CMD_GET_CTRL_MODE 22
93 #define CMD_GET_CTRL_MODE_REPLY 23
94 #define CMD_RESET_CHIP 24
95 #define CMD_RESET_CARD 25
96 #define CMD_START_CHIP 26
97 #define CMD_START_CHIP_REPLY 27
98 #define CMD_STOP_CHIP 28
99 #define CMD_STOP_CHIP_REPLY 29
100 #define CMD_GET_CARD_INFO2 32
101 #define CMD_GET_CARD_INFO 34
102 #define CMD_GET_CARD_INFO_REPLY 35
103 #define CMD_GET_SOFTWARE_INFO 38
104 #define CMD_GET_SOFTWARE_INFO_REPLY 39
105 #define CMD_ERROR_EVENT 45
106 #define CMD_FLUSH_QUEUE 48
107 #define CMD_RESET_ERROR_COUNTER 49
108 #define CMD_TX_ACKNOWLEDGE 50
109 #define CMD_CAN_ERROR_EVENT 51
110 #define CMD_USB_THROTTLE 77
111 #define CMD_LOG_MESSAGE 106
114 #define M16C_EF_ACKE BIT(0)
115 #define M16C_EF_CRCE BIT(1)
116 #define M16C_EF_FORME BIT(2)
117 #define M16C_EF_STFE BIT(3)
118 #define M16C_EF_BITE0 BIT(4)
119 #define M16C_EF_BITE1 BIT(5)
120 #define M16C_EF_RCVE BIT(6)
121 #define M16C_EF_TRE BIT(7)
123 /* bittiming parameters */
124 #define KVASER_USB_TSEG1_MIN 1
125 #define KVASER_USB_TSEG1_MAX 16
126 #define KVASER_USB_TSEG2_MIN 1
127 #define KVASER_USB_TSEG2_MAX 8
128 #define KVASER_USB_SJW_MAX 4
129 #define KVASER_USB_BRP_MIN 1
130 #define KVASER_USB_BRP_MAX 64
131 #define KVASER_USB_BRP_INC 1
134 #define KVASER_CTRL_MODE_NORMAL 1
135 #define KVASER_CTRL_MODE_SILENT 2
136 #define KVASER_CTRL_MODE_SELFRECEPTION 3
137 #define KVASER_CTRL_MODE_OFF 4
139 struct kvaser_msg_simple {
144 struct kvaser_msg_cardinfo {
147 __le32 serial_number;
149 __le32 clock_resolution;
157 struct kvaser_msg_cardinfo2 {
161 __le32 oem_unlock_code;
164 struct kvaser_msg_softinfo {
169 __le16 max_outstanding_tx;
173 struct kvaser_msg_busparams {
183 struct kvaser_msg_tx_can {
191 struct kvaser_msg_rx_can {
198 struct kvaser_msg_chip_state_event {
208 struct kvaser_msg_tx_acknowledge {
216 struct kvaser_msg_error_event {
228 struct kvaser_msg_ctrl_mode {
235 struct kvaser_msg_flush_queue {
242 struct kvaser_msg_log_message {
256 struct kvaser_msg_simple simple;
257 struct kvaser_msg_cardinfo cardinfo;
258 struct kvaser_msg_cardinfo2 cardinfo2;
259 struct kvaser_msg_softinfo softinfo;
260 struct kvaser_msg_busparams busparams;
261 struct kvaser_msg_tx_can tx_can;
262 struct kvaser_msg_rx_can rx_can;
263 struct kvaser_msg_chip_state_event chip_state_event;
264 struct kvaser_msg_tx_acknowledge tx_acknowledge;
265 struct kvaser_msg_error_event error_event;
266 struct kvaser_msg_ctrl_mode ctrl_mode;
267 struct kvaser_msg_flush_queue flush_queue;
268 struct kvaser_msg_log_message log_message;
272 struct kvaser_usb_tx_urb_context {
273 struct kvaser_usb_net_priv *priv;
279 struct usb_device *udev;
280 struct kvaser_usb_net_priv *nets[MAX_NET_DEVICES];
282 struct usb_endpoint_descriptor *bulk_in, *bulk_out;
283 struct usb_anchor rx_submitted;
286 unsigned int nchannels;
289 void *rxbuf[MAX_RX_URBS];
290 dma_addr_t rxbuf_dma[MAX_RX_URBS];
293 struct kvaser_usb_net_priv {
296 atomic_t active_tx_urbs;
297 struct usb_anchor tx_submitted;
298 struct kvaser_usb_tx_urb_context tx_contexts[MAX_TX_URBS];
300 struct completion start_comp, stop_comp;
302 struct kvaser_usb *dev;
303 struct net_device *netdev;
306 struct can_berr_counter bec;
309 static const struct usb_device_id kvaser_usb_table[] = {
310 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_DEVEL_PRODUCT_ID) },
311 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_LITE_PRODUCT_ID) },
312 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_PRO_PRODUCT_ID),
313 .driver_info = KVASER_HAS_TXRX_ERRORS |
314 KVASER_HAS_SILENT_MODE },
315 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_SPRO_PRODUCT_ID),
316 .driver_info = KVASER_HAS_TXRX_ERRORS |
317 KVASER_HAS_SILENT_MODE },
318 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_PRO_LS_PRODUCT_ID),
319 .driver_info = KVASER_HAS_TXRX_ERRORS |
320 KVASER_HAS_SILENT_MODE },
321 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_PRO_SWC_PRODUCT_ID),
322 .driver_info = KVASER_HAS_TXRX_ERRORS |
323 KVASER_HAS_SILENT_MODE },
324 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_PRO_LIN_PRODUCT_ID),
325 .driver_info = KVASER_HAS_TXRX_ERRORS |
326 KVASER_HAS_SILENT_MODE },
327 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_SPRO_LS_PRODUCT_ID),
328 .driver_info = KVASER_HAS_TXRX_ERRORS |
329 KVASER_HAS_SILENT_MODE },
330 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_SPRO_SWC_PRODUCT_ID),
331 .driver_info = KVASER_HAS_TXRX_ERRORS |
332 KVASER_HAS_SILENT_MODE },
333 { USB_DEVICE(KVASER_VENDOR_ID, USB_MEMO2_DEVEL_PRODUCT_ID),
334 .driver_info = KVASER_HAS_TXRX_ERRORS |
335 KVASER_HAS_SILENT_MODE },
336 { USB_DEVICE(KVASER_VENDOR_ID, USB_MEMO2_HSHS_PRODUCT_ID),
337 .driver_info = KVASER_HAS_TXRX_ERRORS |
338 KVASER_HAS_SILENT_MODE },
339 { USB_DEVICE(KVASER_VENDOR_ID, USB_UPRO_HSHS_PRODUCT_ID),
340 .driver_info = KVASER_HAS_TXRX_ERRORS },
341 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_LITE_GI_PRODUCT_ID) },
342 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_PRO_OBDII_PRODUCT_ID),
343 .driver_info = KVASER_HAS_TXRX_ERRORS |
344 KVASER_HAS_SILENT_MODE },
345 { USB_DEVICE(KVASER_VENDOR_ID, USB_MEMO2_HSLS_PRODUCT_ID),
346 .driver_info = KVASER_HAS_TXRX_ERRORS },
347 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_LITE_CH_PRODUCT_ID),
348 .driver_info = KVASER_HAS_TXRX_ERRORS },
349 { USB_DEVICE(KVASER_VENDOR_ID, USB_BLACKBIRD_SPRO_PRODUCT_ID),
350 .driver_info = KVASER_HAS_TXRX_ERRORS },
351 { USB_DEVICE(KVASER_VENDOR_ID, USB_OEM_MERCURY_PRODUCT_ID),
352 .driver_info = KVASER_HAS_TXRX_ERRORS },
353 { USB_DEVICE(KVASER_VENDOR_ID, USB_OEM_LEAF_PRODUCT_ID),
354 .driver_info = KVASER_HAS_TXRX_ERRORS },
355 { USB_DEVICE(KVASER_VENDOR_ID, USB_CAN_R_PRODUCT_ID),
356 .driver_info = KVASER_HAS_TXRX_ERRORS },
359 MODULE_DEVICE_TABLE(usb, kvaser_usb_table);
361 static inline int kvaser_usb_send_msg(const struct kvaser_usb *dev,
362 struct kvaser_msg *msg)
366 return usb_bulk_msg(dev->udev,
367 usb_sndbulkpipe(dev->udev,
368 dev->bulk_out->bEndpointAddress),
369 msg, msg->len, &actual_len,
373 static int kvaser_usb_wait_msg(const struct kvaser_usb *dev, u8 id,
374 struct kvaser_msg *msg)
376 struct kvaser_msg *tmp;
382 buf = kzalloc(RX_BUFFER_SIZE, GFP_KERNEL);
386 err = usb_bulk_msg(dev->udev,
387 usb_rcvbulkpipe(dev->udev,
388 dev->bulk_in->bEndpointAddress),
389 buf, RX_BUFFER_SIZE, &actual_len,
394 while (pos <= actual_len - MSG_HEADER_LEN) {
400 if (pos + tmp->len > actual_len) {
401 dev_err(dev->udev->dev.parent, "Format error\n");
406 memcpy(msg, tmp, tmp->len);
421 static int kvaser_usb_send_simple_msg(const struct kvaser_usb *dev,
422 u8 msg_id, int channel)
424 struct kvaser_msg *msg;
427 msg = kmalloc(sizeof(*msg), GFP_KERNEL);
432 msg->len = MSG_HEADER_LEN + sizeof(struct kvaser_msg_simple);
433 msg->u.simple.channel = channel;
434 msg->u.simple.tid = 0xff;
436 rc = kvaser_usb_send_msg(dev, msg);
442 static int kvaser_usb_get_software_info(struct kvaser_usb *dev)
444 struct kvaser_msg msg;
447 err = kvaser_usb_send_simple_msg(dev, CMD_GET_SOFTWARE_INFO, 0);
451 err = kvaser_usb_wait_msg(dev, CMD_GET_SOFTWARE_INFO_REPLY, &msg);
455 dev->fw_version = le32_to_cpu(msg.u.softinfo.fw_version);
460 static int kvaser_usb_get_card_info(struct kvaser_usb *dev)
462 struct kvaser_msg msg;
465 err = kvaser_usb_send_simple_msg(dev, CMD_GET_CARD_INFO, 0);
469 err = kvaser_usb_wait_msg(dev, CMD_GET_CARD_INFO_REPLY, &msg);
473 dev->nchannels = msg.u.cardinfo.nchannels;
478 static void kvaser_usb_tx_acknowledge(const struct kvaser_usb *dev,
479 const struct kvaser_msg *msg)
481 struct net_device_stats *stats;
482 struct kvaser_usb_tx_urb_context *context;
483 struct kvaser_usb_net_priv *priv;
485 struct can_frame *cf;
486 u8 channel = msg->u.tx_acknowledge.channel;
487 u8 tid = msg->u.tx_acknowledge.tid;
489 if (channel >= dev->nchannels) {
490 dev_err(dev->udev->dev.parent,
491 "Invalid channel number (%d)\n", channel);
495 priv = dev->nets[channel];
497 if (!netif_device_present(priv->netdev))
500 stats = &priv->netdev->stats;
502 context = &priv->tx_contexts[tid % MAX_TX_URBS];
504 /* Sometimes the state change doesn't come after a bus-off event */
505 if (priv->can.restart_ms &&
506 (priv->can.state >= CAN_STATE_BUS_OFF)) {
507 skb = alloc_can_err_skb(priv->netdev, &cf);
509 cf->can_id |= CAN_ERR_RESTARTED;
513 stats->rx_bytes += cf->can_dlc;
515 netdev_err(priv->netdev,
516 "No memory left for err_skb\n");
519 priv->can.can_stats.restarts++;
520 netif_carrier_on(priv->netdev);
522 priv->can.state = CAN_STATE_ERROR_ACTIVE;
526 stats->tx_bytes += context->dlc;
527 can_get_echo_skb(priv->netdev, context->echo_index);
529 context->echo_index = MAX_TX_URBS;
530 atomic_dec(&priv->active_tx_urbs);
532 netif_wake_queue(priv->netdev);
535 static void kvaser_usb_simple_msg_callback(struct urb *urb)
537 struct net_device *netdev = urb->context;
539 kfree(urb->transfer_buffer);
542 netdev_warn(netdev, "urb status received: %d\n",
546 static int kvaser_usb_simple_msg_async(struct kvaser_usb_net_priv *priv,
549 struct kvaser_usb *dev = priv->dev;
550 struct net_device *netdev = priv->netdev;
551 struct kvaser_msg *msg;
556 urb = usb_alloc_urb(0, GFP_ATOMIC);
558 netdev_err(netdev, "No memory left for URBs\n");
562 buf = kmalloc(sizeof(struct kvaser_msg), GFP_ATOMIC);
564 netdev_err(netdev, "No memory left for USB buffer\n");
569 msg = (struct kvaser_msg *)buf;
570 msg->len = MSG_HEADER_LEN + sizeof(struct kvaser_msg_simple);
572 msg->u.simple.channel = priv->channel;
574 usb_fill_bulk_urb(urb, dev->udev,
575 usb_sndbulkpipe(dev->udev,
576 dev->bulk_out->bEndpointAddress),
578 kvaser_usb_simple_msg_callback, priv);
579 usb_anchor_urb(urb, &priv->tx_submitted);
581 err = usb_submit_urb(urb, GFP_ATOMIC);
583 netdev_err(netdev, "Error transmitting URB\n");
584 usb_unanchor_urb(urb);
595 static void kvaser_usb_unlink_tx_urbs(struct kvaser_usb_net_priv *priv)
599 usb_kill_anchored_urbs(&priv->tx_submitted);
600 atomic_set(&priv->active_tx_urbs, 0);
602 for (i = 0; i < MAX_TX_URBS; i++)
603 priv->tx_contexts[i].echo_index = MAX_TX_URBS;
606 static void kvaser_usb_rx_error(const struct kvaser_usb *dev,
607 const struct kvaser_msg *msg)
609 struct can_frame *cf;
611 struct net_device_stats *stats;
612 struct kvaser_usb_net_priv *priv;
613 unsigned int new_state;
614 u8 channel, status, txerr, rxerr, error_factor;
617 case CMD_CAN_ERROR_EVENT:
618 channel = msg->u.error_event.channel;
619 status = msg->u.error_event.status;
620 txerr = msg->u.error_event.tx_errors_count;
621 rxerr = msg->u.error_event.rx_errors_count;
622 error_factor = msg->u.error_event.error_factor;
624 case CMD_LOG_MESSAGE:
625 channel = msg->u.log_message.channel;
626 status = msg->u.log_message.data[0];
627 txerr = msg->u.log_message.data[2];
628 rxerr = msg->u.log_message.data[3];
629 error_factor = msg->u.log_message.data[1];
631 case CMD_CHIP_STATE_EVENT:
632 channel = msg->u.chip_state_event.channel;
633 status = msg->u.chip_state_event.status;
634 txerr = msg->u.chip_state_event.tx_errors_count;
635 rxerr = msg->u.chip_state_event.rx_errors_count;
639 dev_err(dev->udev->dev.parent, "Invalid msg id (%d)\n",
644 if (channel >= dev->nchannels) {
645 dev_err(dev->udev->dev.parent,
646 "Invalid channel number (%d)\n", channel);
650 priv = dev->nets[channel];
651 stats = &priv->netdev->stats;
653 if (status & M16C_STATE_BUS_RESET) {
654 kvaser_usb_unlink_tx_urbs(priv);
658 skb = alloc_can_err_skb(priv->netdev, &cf);
664 new_state = priv->can.state;
666 netdev_dbg(priv->netdev, "Error status: 0x%02x\n", status);
668 if (status & M16C_STATE_BUS_OFF) {
669 cf->can_id |= CAN_ERR_BUSOFF;
671 priv->can.can_stats.bus_off++;
672 if (!priv->can.restart_ms)
673 kvaser_usb_simple_msg_async(priv, CMD_STOP_CHIP);
675 netif_carrier_off(priv->netdev);
677 new_state = CAN_STATE_BUS_OFF;
678 } else if (status & M16C_STATE_BUS_PASSIVE) {
679 if (priv->can.state != CAN_STATE_ERROR_PASSIVE) {
680 cf->can_id |= CAN_ERR_CRTL;
683 cf->data[1] = (txerr > rxerr)
684 ? CAN_ERR_CRTL_TX_PASSIVE
685 : CAN_ERR_CRTL_RX_PASSIVE;
687 cf->data[1] = CAN_ERR_CRTL_TX_PASSIVE |
688 CAN_ERR_CRTL_RX_PASSIVE;
690 priv->can.can_stats.error_passive++;
693 new_state = CAN_STATE_ERROR_PASSIVE;
696 if (status == M16C_STATE_BUS_ERROR) {
697 if ((priv->can.state < CAN_STATE_ERROR_WARNING) &&
698 ((txerr >= 96) || (rxerr >= 96))) {
699 cf->can_id |= CAN_ERR_CRTL;
700 cf->data[1] = (txerr > rxerr)
701 ? CAN_ERR_CRTL_TX_WARNING
702 : CAN_ERR_CRTL_RX_WARNING;
704 priv->can.can_stats.error_warning++;
705 new_state = CAN_STATE_ERROR_WARNING;
706 } else if (priv->can.state > CAN_STATE_ERROR_ACTIVE) {
707 cf->can_id |= CAN_ERR_PROT;
708 cf->data[2] = CAN_ERR_PROT_ACTIVE;
710 new_state = CAN_STATE_ERROR_ACTIVE;
715 cf->can_id |= CAN_ERR_PROT;
716 cf->data[2] = CAN_ERR_PROT_ACTIVE;
718 new_state = CAN_STATE_ERROR_ACTIVE;
721 if (priv->can.restart_ms &&
722 (priv->can.state >= CAN_STATE_BUS_OFF) &&
723 (new_state < CAN_STATE_BUS_OFF)) {
724 cf->can_id |= CAN_ERR_RESTARTED;
725 netif_carrier_on(priv->netdev);
727 priv->can.can_stats.restarts++;
731 priv->can.can_stats.bus_error++;
734 cf->can_id |= CAN_ERR_BUSERROR | CAN_ERR_PROT;
736 if (error_factor & M16C_EF_ACKE)
737 cf->data[3] |= (CAN_ERR_PROT_LOC_ACK);
738 if (error_factor & M16C_EF_CRCE)
739 cf->data[3] |= (CAN_ERR_PROT_LOC_CRC_SEQ |
740 CAN_ERR_PROT_LOC_CRC_DEL);
741 if (error_factor & M16C_EF_FORME)
742 cf->data[2] |= CAN_ERR_PROT_FORM;
743 if (error_factor & M16C_EF_STFE)
744 cf->data[2] |= CAN_ERR_PROT_STUFF;
745 if (error_factor & M16C_EF_BITE0)
746 cf->data[2] |= CAN_ERR_PROT_BIT0;
747 if (error_factor & M16C_EF_BITE1)
748 cf->data[2] |= CAN_ERR_PROT_BIT1;
749 if (error_factor & M16C_EF_TRE)
750 cf->data[2] |= CAN_ERR_PROT_TX;
756 priv->bec.txerr = txerr;
757 priv->bec.rxerr = rxerr;
759 priv->can.state = new_state;
764 stats->rx_bytes += cf->can_dlc;
767 static void kvaser_usb_rx_can_err(const struct kvaser_usb_net_priv *priv,
768 const struct kvaser_msg *msg)
770 struct can_frame *cf;
772 struct net_device_stats *stats = &priv->netdev->stats;
774 if (msg->u.rx_can.flag & (MSG_FLAG_ERROR_FRAME |
776 netdev_err(priv->netdev, "Unknow error (flags: 0x%02x)\n",
783 if (msg->u.rx_can.flag & MSG_FLAG_OVERRUN) {
784 skb = alloc_can_err_skb(priv->netdev, &cf);
790 cf->can_id |= CAN_ERR_CRTL;
791 cf->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
793 stats->rx_over_errors++;
799 stats->rx_bytes += cf->can_dlc;
803 static void kvaser_usb_rx_can_msg(const struct kvaser_usb *dev,
804 const struct kvaser_msg *msg)
806 struct kvaser_usb_net_priv *priv;
807 struct can_frame *cf;
809 struct net_device_stats *stats;
810 u8 channel = msg->u.rx_can.channel;
812 if (channel >= dev->nchannels) {
813 dev_err(dev->udev->dev.parent,
814 "Invalid channel number (%d)\n", channel);
818 priv = dev->nets[channel];
819 stats = &priv->netdev->stats;
821 if (msg->u.rx_can.flag & (MSG_FLAG_ERROR_FRAME | MSG_FLAG_NERR |
823 kvaser_usb_rx_can_err(priv, msg);
825 } else if (msg->u.rx_can.flag & ~MSG_FLAG_REMOTE_FRAME) {
826 netdev_warn(priv->netdev,
827 "Unhandled frame (flags: 0x%02x)",
832 skb = alloc_can_skb(priv->netdev, &cf);
838 cf->can_id = ((msg->u.rx_can.msg[0] & 0x1f) << 6) |
839 (msg->u.rx_can.msg[1] & 0x3f);
840 cf->can_dlc = get_can_dlc(msg->u.rx_can.msg[5]);
842 if (msg->id == CMD_RX_EXT_MESSAGE) {
844 cf->can_id |= ((msg->u.rx_can.msg[2] & 0x0f) << 14) |
845 ((msg->u.rx_can.msg[3] & 0xff) << 6) |
846 (msg->u.rx_can.msg[4] & 0x3f);
847 cf->can_id |= CAN_EFF_FLAG;
850 if (msg->u.rx_can.flag & MSG_FLAG_REMOTE_FRAME)
851 cf->can_id |= CAN_RTR_FLAG;
853 memcpy(cf->data, &msg->u.rx_can.msg[6], cf->can_dlc);
858 stats->rx_bytes += cf->can_dlc;
861 static void kvaser_usb_start_chip_reply(const struct kvaser_usb *dev,
862 const struct kvaser_msg *msg)
864 struct kvaser_usb_net_priv *priv;
865 u8 channel = msg->u.simple.channel;
867 if (channel >= dev->nchannels) {
868 dev_err(dev->udev->dev.parent,
869 "Invalid channel number (%d)\n", channel);
873 priv = dev->nets[channel];
875 if (completion_done(&priv->start_comp) &&
876 netif_queue_stopped(priv->netdev)) {
877 netif_wake_queue(priv->netdev);
879 netif_start_queue(priv->netdev);
880 complete(&priv->start_comp);
884 static void kvaser_usb_stop_chip_reply(const struct kvaser_usb *dev,
885 const struct kvaser_msg *msg)
887 struct kvaser_usb_net_priv *priv;
888 u8 channel = msg->u.simple.channel;
890 if (channel >= dev->nchannels) {
891 dev_err(dev->udev->dev.parent,
892 "Invalid channel number (%d)\n", channel);
896 priv = dev->nets[channel];
898 complete(&priv->stop_comp);
901 static void kvaser_usb_handle_message(const struct kvaser_usb *dev,
902 const struct kvaser_msg *msg)
905 case CMD_START_CHIP_REPLY:
906 kvaser_usb_start_chip_reply(dev, msg);
909 case CMD_STOP_CHIP_REPLY:
910 kvaser_usb_stop_chip_reply(dev, msg);
913 case CMD_RX_STD_MESSAGE:
914 case CMD_RX_EXT_MESSAGE:
915 kvaser_usb_rx_can_msg(dev, msg);
918 case CMD_CHIP_STATE_EVENT:
919 case CMD_CAN_ERROR_EVENT:
920 kvaser_usb_rx_error(dev, msg);
923 case CMD_LOG_MESSAGE:
924 if (msg->u.log_message.flags & MSG_FLAG_ERROR_FRAME)
925 kvaser_usb_rx_error(dev, msg);
928 case CMD_TX_ACKNOWLEDGE:
929 kvaser_usb_tx_acknowledge(dev, msg);
933 dev_warn(dev->udev->dev.parent,
934 "Unhandled message (%d)\n", msg->id);
939 static void kvaser_usb_read_bulk_callback(struct urb *urb)
941 struct kvaser_usb *dev = urb->context;
942 struct kvaser_msg *msg;
946 switch (urb->status) {
953 dev_info(dev->udev->dev.parent, "Rx URB aborted (%d)\n",
958 while (pos <= urb->actual_length - MSG_HEADER_LEN) {
959 msg = urb->transfer_buffer + pos;
964 if (pos + msg->len > urb->actual_length) {
965 dev_err(dev->udev->dev.parent, "Format error\n");
969 kvaser_usb_handle_message(dev, msg);
975 usb_fill_bulk_urb(urb, dev->udev,
976 usb_rcvbulkpipe(dev->udev,
977 dev->bulk_in->bEndpointAddress),
978 urb->transfer_buffer, RX_BUFFER_SIZE,
979 kvaser_usb_read_bulk_callback, dev);
981 err = usb_submit_urb(urb, GFP_ATOMIC);
982 if (err == -ENODEV) {
983 for (i = 0; i < dev->nchannels; i++) {
987 netif_device_detach(dev->nets[i]->netdev);
990 dev_err(dev->udev->dev.parent,
991 "Failed resubmitting read bulk urb: %d\n", err);
997 static int kvaser_usb_setup_rx_urbs(struct kvaser_usb *dev)
1001 if (dev->rxinitdone)
1004 for (i = 0; i < MAX_RX_URBS; i++) {
1005 struct urb *urb = NULL;
1009 urb = usb_alloc_urb(0, GFP_KERNEL);
1011 dev_warn(dev->udev->dev.parent,
1012 "No memory left for URBs\n");
1017 buf = usb_alloc_coherent(dev->udev, RX_BUFFER_SIZE,
1018 GFP_KERNEL, &buf_dma);
1020 dev_warn(dev->udev->dev.parent,
1021 "No memory left for USB buffer\n");
1027 usb_fill_bulk_urb(urb, dev->udev,
1028 usb_rcvbulkpipe(dev->udev,
1029 dev->bulk_in->bEndpointAddress),
1030 buf, RX_BUFFER_SIZE,
1031 kvaser_usb_read_bulk_callback,
1033 urb->transfer_dma = buf_dma;
1034 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1035 usb_anchor_urb(urb, &dev->rx_submitted);
1037 err = usb_submit_urb(urb, GFP_KERNEL);
1039 usb_unanchor_urb(urb);
1040 usb_free_coherent(dev->udev, RX_BUFFER_SIZE, buf,
1046 dev->rxbuf[i] = buf;
1047 dev->rxbuf_dma[i] = buf_dma;
1053 dev_warn(dev->udev->dev.parent,
1054 "Cannot setup read URBs, error %d\n", err);
1056 } else if (i < MAX_RX_URBS) {
1057 dev_warn(dev->udev->dev.parent,
1058 "RX performances may be slow\n");
1061 dev->rxinitdone = true;
1066 static int kvaser_usb_set_opt_mode(const struct kvaser_usb_net_priv *priv)
1068 struct kvaser_msg *msg;
1071 msg = kmalloc(sizeof(*msg), GFP_KERNEL);
1075 msg->id = CMD_SET_CTRL_MODE;
1076 msg->len = MSG_HEADER_LEN + sizeof(struct kvaser_msg_ctrl_mode);
1077 msg->u.ctrl_mode.tid = 0xff;
1078 msg->u.ctrl_mode.channel = priv->channel;
1080 if (priv->can.ctrlmode & CAN_CTRLMODE_LISTENONLY)
1081 msg->u.ctrl_mode.ctrl_mode = KVASER_CTRL_MODE_SILENT;
1083 msg->u.ctrl_mode.ctrl_mode = KVASER_CTRL_MODE_NORMAL;
1085 rc = kvaser_usb_send_msg(priv->dev, msg);
1091 static int kvaser_usb_start_chip(struct kvaser_usb_net_priv *priv)
1095 init_completion(&priv->start_comp);
1097 err = kvaser_usb_send_simple_msg(priv->dev, CMD_START_CHIP,
1102 if (!wait_for_completion_timeout(&priv->start_comp,
1103 msecs_to_jiffies(START_TIMEOUT)))
1109 static int kvaser_usb_open(struct net_device *netdev)
1111 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1112 struct kvaser_usb *dev = priv->dev;
1115 err = open_candev(netdev);
1119 err = kvaser_usb_setup_rx_urbs(dev);
1123 err = kvaser_usb_set_opt_mode(priv);
1127 err = kvaser_usb_start_chip(priv);
1129 netdev_warn(netdev, "Cannot start device, error %d\n", err);
1133 priv->can.state = CAN_STATE_ERROR_ACTIVE;
1138 close_candev(netdev);
1142 static void kvaser_usb_unlink_all_urbs(struct kvaser_usb *dev)
1146 usb_kill_anchored_urbs(&dev->rx_submitted);
1148 for (i = 0; i < MAX_RX_URBS; i++)
1149 usb_free_coherent(dev->udev, RX_BUFFER_SIZE,
1153 for (i = 0; i < MAX_NET_DEVICES; i++) {
1154 struct kvaser_usb_net_priv *priv = dev->nets[i];
1157 kvaser_usb_unlink_tx_urbs(priv);
1161 static int kvaser_usb_stop_chip(struct kvaser_usb_net_priv *priv)
1165 init_completion(&priv->stop_comp);
1167 err = kvaser_usb_send_simple_msg(priv->dev, CMD_STOP_CHIP,
1172 if (!wait_for_completion_timeout(&priv->stop_comp,
1173 msecs_to_jiffies(STOP_TIMEOUT)))
1179 static int kvaser_usb_flush_queue(struct kvaser_usb_net_priv *priv)
1181 struct kvaser_msg *msg;
1184 msg = kmalloc(sizeof(*msg), GFP_KERNEL);
1188 msg->id = CMD_FLUSH_QUEUE;
1189 msg->len = MSG_HEADER_LEN + sizeof(struct kvaser_msg_flush_queue);
1190 msg->u.flush_queue.channel = priv->channel;
1191 msg->u.flush_queue.flags = 0x00;
1193 rc = kvaser_usb_send_msg(priv->dev, msg);
1199 static int kvaser_usb_close(struct net_device *netdev)
1201 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1202 struct kvaser_usb *dev = priv->dev;
1205 netif_stop_queue(netdev);
1207 err = kvaser_usb_flush_queue(priv);
1209 netdev_warn(netdev, "Cannot flush queue, error %d\n", err);
1211 if (kvaser_usb_send_simple_msg(dev, CMD_RESET_CHIP, priv->channel))
1212 netdev_warn(netdev, "Cannot reset card, error %d\n", err);
1214 err = kvaser_usb_stop_chip(priv);
1216 netdev_warn(netdev, "Cannot stop device, error %d\n", err);
1218 priv->can.state = CAN_STATE_STOPPED;
1219 close_candev(priv->netdev);
1224 static void kvaser_usb_write_bulk_callback(struct urb *urb)
1226 struct kvaser_usb_tx_urb_context *context = urb->context;
1227 struct kvaser_usb_net_priv *priv;
1228 struct net_device *netdev;
1230 if (WARN_ON(!context))
1233 priv = context->priv;
1234 netdev = priv->netdev;
1236 kfree(urb->transfer_buffer);
1238 if (!netif_device_present(netdev))
1242 netdev_info(netdev, "Tx URB aborted (%d)\n", urb->status);
1245 static netdev_tx_t kvaser_usb_start_xmit(struct sk_buff *skb,
1246 struct net_device *netdev)
1248 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1249 struct kvaser_usb *dev = priv->dev;
1250 struct net_device_stats *stats = &netdev->stats;
1251 struct can_frame *cf = (struct can_frame *)skb->data;
1252 struct kvaser_usb_tx_urb_context *context = NULL;
1255 struct kvaser_msg *msg;
1257 int ret = NETDEV_TX_OK;
1259 if (can_dropped_invalid_skb(netdev, skb))
1260 return NETDEV_TX_OK;
1262 urb = usb_alloc_urb(0, GFP_ATOMIC);
1264 netdev_err(netdev, "No memory left for URBs\n");
1265 stats->tx_dropped++;
1269 buf = kmalloc(sizeof(struct kvaser_msg), GFP_ATOMIC);
1271 netdev_err(netdev, "No memory left for USB buffer\n");
1272 stats->tx_dropped++;
1277 msg->len = MSG_HEADER_LEN + sizeof(struct kvaser_msg_tx_can);
1278 msg->u.tx_can.flags = 0;
1279 msg->u.tx_can.channel = priv->channel;
1281 if (cf->can_id & CAN_EFF_FLAG) {
1282 msg->id = CMD_TX_EXT_MESSAGE;
1283 msg->u.tx_can.msg[0] = (cf->can_id >> 24) & 0x1f;
1284 msg->u.tx_can.msg[1] = (cf->can_id >> 18) & 0x3f;
1285 msg->u.tx_can.msg[2] = (cf->can_id >> 14) & 0x0f;
1286 msg->u.tx_can.msg[3] = (cf->can_id >> 6) & 0xff;
1287 msg->u.tx_can.msg[4] = cf->can_id & 0x3f;
1289 msg->id = CMD_TX_STD_MESSAGE;
1290 msg->u.tx_can.msg[0] = (cf->can_id >> 6) & 0x1f;
1291 msg->u.tx_can.msg[1] = cf->can_id & 0x3f;
1294 msg->u.tx_can.msg[5] = cf->can_dlc;
1295 memcpy(&msg->u.tx_can.msg[6], cf->data, cf->can_dlc);
1297 if (cf->can_id & CAN_RTR_FLAG)
1298 msg->u.tx_can.flags |= MSG_FLAG_REMOTE_FRAME;
1300 for (i = 0; i < ARRAY_SIZE(priv->tx_contexts); i++) {
1301 if (priv->tx_contexts[i].echo_index == MAX_TX_URBS) {
1302 context = &priv->tx_contexts[i];
1308 netdev_warn(netdev, "cannot find free context\n");
1309 ret = NETDEV_TX_BUSY;
1313 context->priv = priv;
1314 context->echo_index = i;
1315 context->dlc = cf->can_dlc;
1317 msg->u.tx_can.tid = context->echo_index;
1319 usb_fill_bulk_urb(urb, dev->udev,
1320 usb_sndbulkpipe(dev->udev,
1321 dev->bulk_out->bEndpointAddress),
1323 kvaser_usb_write_bulk_callback, context);
1324 usb_anchor_urb(urb, &priv->tx_submitted);
1326 can_put_echo_skb(skb, netdev, context->echo_index);
1328 atomic_inc(&priv->active_tx_urbs);
1330 if (atomic_read(&priv->active_tx_urbs) >= MAX_TX_URBS)
1331 netif_stop_queue(netdev);
1333 err = usb_submit_urb(urb, GFP_ATOMIC);
1334 if (unlikely(err)) {
1335 can_free_echo_skb(netdev, context->echo_index);
1337 skb = NULL; /* set to NULL to avoid double free in
1338 * dev_kfree_skb(skb) */
1340 atomic_dec(&priv->active_tx_urbs);
1341 usb_unanchor_urb(urb);
1343 stats->tx_dropped++;
1346 netif_device_detach(netdev);
1348 netdev_warn(netdev, "Failed tx_urb %d\n", err);
1355 return NETDEV_TX_OK;
1366 static const struct net_device_ops kvaser_usb_netdev_ops = {
1367 .ndo_open = kvaser_usb_open,
1368 .ndo_stop = kvaser_usb_close,
1369 .ndo_start_xmit = kvaser_usb_start_xmit,
1372 static const struct can_bittiming_const kvaser_usb_bittiming_const = {
1373 .name = "kvaser_usb",
1374 .tseg1_min = KVASER_USB_TSEG1_MIN,
1375 .tseg1_max = KVASER_USB_TSEG1_MAX,
1376 .tseg2_min = KVASER_USB_TSEG2_MIN,
1377 .tseg2_max = KVASER_USB_TSEG2_MAX,
1378 .sjw_max = KVASER_USB_SJW_MAX,
1379 .brp_min = KVASER_USB_BRP_MIN,
1380 .brp_max = KVASER_USB_BRP_MAX,
1381 .brp_inc = KVASER_USB_BRP_INC,
1384 static int kvaser_usb_set_bittiming(struct net_device *netdev)
1386 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1387 struct can_bittiming *bt = &priv->can.bittiming;
1388 struct kvaser_usb *dev = priv->dev;
1389 struct kvaser_msg *msg;
1392 msg = kmalloc(sizeof(*msg), GFP_KERNEL);
1396 msg->id = CMD_SET_BUS_PARAMS;
1397 msg->len = MSG_HEADER_LEN + sizeof(struct kvaser_msg_busparams);
1398 msg->u.busparams.channel = priv->channel;
1399 msg->u.busparams.tid = 0xff;
1400 msg->u.busparams.bitrate = cpu_to_le32(bt->bitrate);
1401 msg->u.busparams.sjw = bt->sjw;
1402 msg->u.busparams.tseg1 = bt->prop_seg + bt->phase_seg1;
1403 msg->u.busparams.tseg2 = bt->phase_seg2;
1405 if (priv->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES)
1406 msg->u.busparams.no_samp = 3;
1408 msg->u.busparams.no_samp = 1;
1410 rc = kvaser_usb_send_msg(dev, msg);
1416 static int kvaser_usb_set_mode(struct net_device *netdev,
1419 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1423 case CAN_MODE_START:
1424 err = kvaser_usb_simple_msg_async(priv, CMD_START_CHIP);
1435 static int kvaser_usb_get_berr_counter(const struct net_device *netdev,
1436 struct can_berr_counter *bec)
1438 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1445 static void kvaser_usb_remove_interfaces(struct kvaser_usb *dev)
1449 for (i = 0; i < dev->nchannels; i++) {
1453 unregister_netdev(dev->nets[i]->netdev);
1456 kvaser_usb_unlink_all_urbs(dev);
1458 for (i = 0; i < dev->nchannels; i++) {
1462 free_candev(dev->nets[i]->netdev);
1466 static int kvaser_usb_init_one(struct usb_interface *intf,
1467 const struct usb_device_id *id, int channel)
1469 struct kvaser_usb *dev = usb_get_intfdata(intf);
1470 struct net_device *netdev;
1471 struct kvaser_usb_net_priv *priv;
1474 netdev = alloc_candev(sizeof(*priv), MAX_TX_URBS);
1476 dev_err(&intf->dev, "Cannot alloc candev\n");
1480 priv = netdev_priv(netdev);
1482 init_completion(&priv->start_comp);
1483 init_completion(&priv->stop_comp);
1485 init_usb_anchor(&priv->tx_submitted);
1486 atomic_set(&priv->active_tx_urbs, 0);
1488 for (i = 0; i < ARRAY_SIZE(priv->tx_contexts); i++)
1489 priv->tx_contexts[i].echo_index = MAX_TX_URBS;
1492 priv->netdev = netdev;
1493 priv->channel = channel;
1495 priv->can.state = CAN_STATE_STOPPED;
1496 priv->can.clock.freq = CAN_USB_CLOCK;
1497 priv->can.bittiming_const = &kvaser_usb_bittiming_const;
1498 priv->can.do_set_bittiming = kvaser_usb_set_bittiming;
1499 priv->can.do_set_mode = kvaser_usb_set_mode;
1500 if (id->driver_info & KVASER_HAS_TXRX_ERRORS)
1501 priv->can.do_get_berr_counter = kvaser_usb_get_berr_counter;
1502 priv->can.ctrlmode_supported = CAN_CTRLMODE_3_SAMPLES;
1503 if (id->driver_info & KVASER_HAS_SILENT_MODE)
1504 priv->can.ctrlmode_supported |= CAN_CTRLMODE_LISTENONLY;
1506 netdev->flags |= IFF_ECHO;
1508 netdev->netdev_ops = &kvaser_usb_netdev_ops;
1510 SET_NETDEV_DEV(netdev, &intf->dev);
1512 dev->nets[channel] = priv;
1514 err = register_candev(netdev);
1516 dev_err(&intf->dev, "Failed to register can device\n");
1517 free_candev(netdev);
1518 dev->nets[channel] = NULL;
1522 netdev_dbg(netdev, "device registered\n");
1527 static void kvaser_usb_get_endpoints(const struct usb_interface *intf,
1528 struct usb_endpoint_descriptor **in,
1529 struct usb_endpoint_descriptor **out)
1531 const struct usb_host_interface *iface_desc;
1532 struct usb_endpoint_descriptor *endpoint;
1535 iface_desc = &intf->altsetting[0];
1537 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
1538 endpoint = &iface_desc->endpoint[i].desc;
1540 if (usb_endpoint_is_bulk_in(endpoint))
1543 if (usb_endpoint_is_bulk_out(endpoint))
1548 static int kvaser_usb_probe(struct usb_interface *intf,
1549 const struct usb_device_id *id)
1551 struct kvaser_usb *dev;
1555 dev = devm_kzalloc(&intf->dev, sizeof(*dev), GFP_KERNEL);
1559 kvaser_usb_get_endpoints(intf, &dev->bulk_in, &dev->bulk_out);
1560 if (!dev->bulk_in || !dev->bulk_out) {
1561 dev_err(&intf->dev, "Cannot get usb endpoint(s)");
1565 dev->udev = interface_to_usbdev(intf);
1567 init_usb_anchor(&dev->rx_submitted);
1569 usb_set_intfdata(intf, dev);
1571 for (i = 0; i < MAX_NET_DEVICES; i++)
1572 kvaser_usb_send_simple_msg(dev, CMD_RESET_CHIP, i);
1574 err = kvaser_usb_get_software_info(dev);
1577 "Cannot get software infos, error %d\n", err);
1581 err = kvaser_usb_get_card_info(dev);
1584 "Cannot get card infos, error %d\n", err);
1588 dev_dbg(&intf->dev, "Firmware version: %d.%d.%d\n",
1589 ((dev->fw_version >> 24) & 0xff),
1590 ((dev->fw_version >> 16) & 0xff),
1591 (dev->fw_version & 0xffff));
1593 for (i = 0; i < dev->nchannels; i++) {
1594 err = kvaser_usb_init_one(intf, id, i);
1596 kvaser_usb_remove_interfaces(dev);
1604 static void kvaser_usb_disconnect(struct usb_interface *intf)
1606 struct kvaser_usb *dev = usb_get_intfdata(intf);
1608 usb_set_intfdata(intf, NULL);
1613 kvaser_usb_remove_interfaces(dev);
1616 static struct usb_driver kvaser_usb_driver = {
1617 .name = "kvaser_usb",
1618 .probe = kvaser_usb_probe,
1619 .disconnect = kvaser_usb_disconnect,
1620 .id_table = kvaser_usb_table,
1623 module_usb_driver(kvaser_usb_driver);
1625 MODULE_AUTHOR("Olivier Sobrie <olivier@sobrie.be>");
1626 MODULE_DESCRIPTION("CAN driver for Kvaser CAN/USB devices");
1627 MODULE_LICENSE("GPL v2");