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
9 * - Kvaser linux usbcanII driver (version 5.3)
11 * Copyright (C) 2002-2006 KVASER AB, Sweden. All rights reserved.
12 * Copyright (C) 2010 Matthias Fuchs <matthias.fuchs@esd.eu>, esd gmbh
13 * Copyright (C) 2012 Olivier Sobrie <olivier@sobrie.be>
14 * Copyright (C) 2015 Valeo S.A.
17 #include <linux/spinlock.h>
18 #include <linux/kernel.h>
19 #include <linux/completion.h>
20 #include <linux/module.h>
21 #include <linux/netdevice.h>
22 #include <linux/usb.h>
24 #include <linux/can.h>
25 #include <linux/can/dev.h>
26 #include <linux/can/error.h>
29 #define START_TIMEOUT 1000 /* msecs */
30 #define STOP_TIMEOUT 1000 /* msecs */
31 #define USB_SEND_TIMEOUT 1000 /* msecs */
32 #define USB_RECV_TIMEOUT 1000 /* msecs */
33 #define RX_BUFFER_SIZE 3072
34 #define CAN_USB_CLOCK 8000000
35 #define MAX_NET_DEVICES 3
36 #define MAX_USBCAN_NET_DEVICES 2
38 /* Kvaser Leaf USB devices */
39 #define KVASER_VENDOR_ID 0x0bfd
40 #define USB_LEAF_DEVEL_PRODUCT_ID 10
41 #define USB_LEAF_LITE_PRODUCT_ID 11
42 #define USB_LEAF_PRO_PRODUCT_ID 12
43 #define USB_LEAF_SPRO_PRODUCT_ID 14
44 #define USB_LEAF_PRO_LS_PRODUCT_ID 15
45 #define USB_LEAF_PRO_SWC_PRODUCT_ID 16
46 #define USB_LEAF_PRO_LIN_PRODUCT_ID 17
47 #define USB_LEAF_SPRO_LS_PRODUCT_ID 18
48 #define USB_LEAF_SPRO_SWC_PRODUCT_ID 19
49 #define USB_MEMO2_DEVEL_PRODUCT_ID 22
50 #define USB_MEMO2_HSHS_PRODUCT_ID 23
51 #define USB_UPRO_HSHS_PRODUCT_ID 24
52 #define USB_LEAF_LITE_GI_PRODUCT_ID 25
53 #define USB_LEAF_PRO_OBDII_PRODUCT_ID 26
54 #define USB_MEMO2_HSLS_PRODUCT_ID 27
55 #define USB_LEAF_LITE_CH_PRODUCT_ID 28
56 #define USB_BLACKBIRD_SPRO_PRODUCT_ID 29
57 #define USB_OEM_MERCURY_PRODUCT_ID 34
58 #define USB_OEM_LEAF_PRODUCT_ID 35
59 #define USB_CAN_R_PRODUCT_ID 39
60 #define USB_LEAF_LITE_V2_PRODUCT_ID 288
61 #define USB_MINI_PCIE_HS_PRODUCT_ID 289
62 #define USB_LEAF_LIGHT_HS_V2_OEM_PRODUCT_ID 290
63 #define USB_USBCAN_LIGHT_2HS_PRODUCT_ID 291
64 #define USB_MINI_PCIE_2HS_PRODUCT_ID 292
66 static inline bool kvaser_is_leaf(const struct usb_device_id *id)
68 return id->idProduct >= USB_LEAF_DEVEL_PRODUCT_ID &&
69 id->idProduct <= USB_MINI_PCIE_2HS_PRODUCT_ID;
72 /* Kvaser USBCan-II devices */
73 #define USB_USBCAN_REVB_PRODUCT_ID 2
74 #define USB_VCI2_PRODUCT_ID 3
75 #define USB_USBCAN2_PRODUCT_ID 4
76 #define USB_MEMORATOR_PRODUCT_ID 5
78 static inline bool kvaser_is_usbcan(const struct usb_device_id *id)
80 return id->idProduct >= USB_USBCAN_REVB_PRODUCT_ID &&
81 id->idProduct <= USB_MEMORATOR_PRODUCT_ID;
84 /* USB devices features */
85 #define KVASER_HAS_SILENT_MODE BIT(0)
86 #define KVASER_HAS_TXRX_ERRORS BIT(1)
88 /* Message header size */
89 #define MSG_HEADER_LEN 2
91 /* Can message flags */
92 #define MSG_FLAG_ERROR_FRAME BIT(0)
93 #define MSG_FLAG_OVERRUN BIT(1)
94 #define MSG_FLAG_NERR BIT(2)
95 #define MSG_FLAG_WAKEUP BIT(3)
96 #define MSG_FLAG_REMOTE_FRAME BIT(4)
97 #define MSG_FLAG_RESERVED BIT(5)
98 #define MSG_FLAG_TX_ACK BIT(6)
99 #define MSG_FLAG_TX_REQUEST BIT(7)
101 /* Can states (M16C CxSTRH register) */
102 #define M16C_STATE_BUS_RESET BIT(0)
103 #define M16C_STATE_BUS_ERROR BIT(4)
104 #define M16C_STATE_BUS_PASSIVE BIT(5)
105 #define M16C_STATE_BUS_OFF BIT(6)
108 #define CMD_RX_STD_MESSAGE 12
109 #define CMD_TX_STD_MESSAGE 13
110 #define CMD_RX_EXT_MESSAGE 14
111 #define CMD_TX_EXT_MESSAGE 15
112 #define CMD_SET_BUS_PARAMS 16
113 #define CMD_GET_BUS_PARAMS 17
114 #define CMD_GET_BUS_PARAMS_REPLY 18
115 #define CMD_GET_CHIP_STATE 19
116 #define CMD_CHIP_STATE_EVENT 20
117 #define CMD_SET_CTRL_MODE 21
118 #define CMD_GET_CTRL_MODE 22
119 #define CMD_GET_CTRL_MODE_REPLY 23
120 #define CMD_RESET_CHIP 24
121 #define CMD_RESET_CARD 25
122 #define CMD_START_CHIP 26
123 #define CMD_START_CHIP_REPLY 27
124 #define CMD_STOP_CHIP 28
125 #define CMD_STOP_CHIP_REPLY 29
127 #define CMD_LEAF_GET_CARD_INFO2 32
128 #define CMD_USBCAN_RESET_CLOCK 32
129 #define CMD_USBCAN_CLOCK_OVERFLOW_EVENT 33
131 #define CMD_GET_CARD_INFO 34
132 #define CMD_GET_CARD_INFO_REPLY 35
133 #define CMD_GET_SOFTWARE_INFO 38
134 #define CMD_GET_SOFTWARE_INFO_REPLY 39
135 #define CMD_ERROR_EVENT 45
136 #define CMD_FLUSH_QUEUE 48
137 #define CMD_RESET_ERROR_COUNTER 49
138 #define CMD_TX_ACKNOWLEDGE 50
139 #define CMD_CAN_ERROR_EVENT 51
140 #define CMD_FLUSH_QUEUE_REPLY 68
142 #define CMD_LEAF_USB_THROTTLE 77
143 #define CMD_LEAF_LOG_MESSAGE 106
146 #define M16C_EF_ACKE BIT(0)
147 #define M16C_EF_CRCE BIT(1)
148 #define M16C_EF_FORME BIT(2)
149 #define M16C_EF_STFE BIT(3)
150 #define M16C_EF_BITE0 BIT(4)
151 #define M16C_EF_BITE1 BIT(5)
152 #define M16C_EF_RCVE BIT(6)
153 #define M16C_EF_TRE BIT(7)
155 /* Only Leaf-based devices can report M16C error factors,
156 * thus define our own error status flags for USBCANII
158 #define USBCAN_ERROR_STATE_NONE 0
159 #define USBCAN_ERROR_STATE_TX_ERROR BIT(0)
160 #define USBCAN_ERROR_STATE_RX_ERROR BIT(1)
161 #define USBCAN_ERROR_STATE_BUSERROR BIT(2)
163 /* bittiming parameters */
164 #define KVASER_USB_TSEG1_MIN 1
165 #define KVASER_USB_TSEG1_MAX 16
166 #define KVASER_USB_TSEG2_MIN 1
167 #define KVASER_USB_TSEG2_MAX 8
168 #define KVASER_USB_SJW_MAX 4
169 #define KVASER_USB_BRP_MIN 1
170 #define KVASER_USB_BRP_MAX 64
171 #define KVASER_USB_BRP_INC 1
174 #define KVASER_CTRL_MODE_NORMAL 1
175 #define KVASER_CTRL_MODE_SILENT 2
176 #define KVASER_CTRL_MODE_SELFRECEPTION 3
177 #define KVASER_CTRL_MODE_OFF 4
179 /* Extended CAN identifier flag */
180 #define KVASER_EXTENDED_FRAME BIT(31)
182 /* Kvaser USB CAN dongles are divided into two major families:
183 * - Leaf: Based on Renesas M32C, running firmware labeled as 'filo'
184 * - UsbcanII: Based on Renesas M16C, running firmware labeled as 'helios'
186 enum kvaser_usb_family {
191 struct kvaser_msg_simple {
196 struct kvaser_msg_cardinfo {
201 __le32 serial_number;
205 __le32 serial_number_low;
206 __le32 serial_number_high;
209 __le32 clock_resolution;
224 struct kvaser_msg_cardinfo2 {
228 __le32 oem_unlock_code;
231 struct leaf_msg_softinfo {
236 __le16 max_outstanding_tx;
240 struct usbcan_msg_softinfo {
243 __le16 max_outstanding_tx;
250 struct kvaser_msg_busparams {
260 struct kvaser_msg_tx_can {
276 struct kvaser_msg_rx_can_header {
281 struct leaf_msg_rx_can {
289 struct usbcan_msg_rx_can {
297 struct leaf_msg_chip_state_event {
309 struct usbcan_msg_chip_state_event {
321 struct kvaser_msg_tx_acknowledge_header {
326 struct leaf_msg_tx_acknowledge {
335 struct usbcan_msg_tx_acknowledge {
343 struct leaf_msg_error_event {
355 struct usbcan_msg_error_event {
358 u8 tx_errors_count_ch0;
359 u8 rx_errors_count_ch0;
360 u8 tx_errors_count_ch1;
361 u8 rx_errors_count_ch1;
367 struct kvaser_msg_ctrl_mode {
374 struct kvaser_msg_flush_queue {
381 struct leaf_msg_log_message {
395 struct kvaser_msg_simple simple;
396 struct kvaser_msg_cardinfo cardinfo;
397 struct kvaser_msg_cardinfo2 cardinfo2;
398 struct kvaser_msg_busparams busparams;
400 struct kvaser_msg_rx_can_header rx_can_header;
401 struct kvaser_msg_tx_acknowledge_header tx_acknowledge_header;
404 struct leaf_msg_softinfo softinfo;
405 struct leaf_msg_rx_can rx_can;
406 struct leaf_msg_chip_state_event chip_state_event;
407 struct leaf_msg_tx_acknowledge tx_acknowledge;
408 struct leaf_msg_error_event error_event;
409 struct leaf_msg_log_message log_message;
413 struct usbcan_msg_softinfo softinfo;
414 struct usbcan_msg_rx_can rx_can;
415 struct usbcan_msg_chip_state_event chip_state_event;
416 struct usbcan_msg_tx_acknowledge tx_acknowledge;
417 struct usbcan_msg_error_event error_event;
420 struct kvaser_msg_tx_can tx_can;
421 struct kvaser_msg_ctrl_mode ctrl_mode;
422 struct kvaser_msg_flush_queue flush_queue;
426 /* Summary of a kvaser error event, for a unified Leaf/Usbcan error
427 * handling. Some discrepancies between the two families exist:
429 * - USBCAN firmware does not report M16C "error factors"
430 * - USBCAN controllers has difficulties reporting if the raised error
431 * event is for ch0 or ch1. They leave such arbitration to the OS
432 * driver by letting it compare error counters with previous values
433 * and decide the error event's channel. Thus for USBCAN, the channel
434 * field is only advisory.
436 struct kvaser_usb_error_summary {
437 u8 channel, status, txerr, rxerr;
449 /* Context for an outstanding, not yet ACKed, transmission */
450 struct kvaser_usb_tx_urb_context {
451 struct kvaser_usb_net_priv *priv;
457 struct usb_device *udev;
458 struct kvaser_usb_net_priv *nets[MAX_NET_DEVICES];
460 struct usb_endpoint_descriptor *bulk_in, *bulk_out;
461 struct usb_anchor rx_submitted;
463 /* @max_tx_urbs: Firmware-reported maximum number of outstanding,
464 * not yet ACKed, transmissions on this device. This value is
465 * also used as a sentinel for marking free tx contexts.
468 unsigned int nchannels;
469 unsigned int max_tx_urbs;
470 enum kvaser_usb_family family;
473 void *rxbuf[MAX_RX_URBS];
474 dma_addr_t rxbuf_dma[MAX_RX_URBS];
477 struct kvaser_usb_net_priv {
479 struct can_berr_counter bec;
481 struct kvaser_usb *dev;
482 struct net_device *netdev;
485 struct completion start_comp, stop_comp;
486 struct usb_anchor tx_submitted;
488 spinlock_t tx_contexts_lock;
489 int active_tx_contexts;
490 struct kvaser_usb_tx_urb_context tx_contexts[];
493 static const struct usb_device_id kvaser_usb_table[] = {
494 /* Leaf family IDs */
495 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_DEVEL_PRODUCT_ID) },
496 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_LITE_PRODUCT_ID) },
497 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_PRO_PRODUCT_ID),
498 .driver_info = KVASER_HAS_TXRX_ERRORS |
499 KVASER_HAS_SILENT_MODE },
500 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_SPRO_PRODUCT_ID),
501 .driver_info = KVASER_HAS_TXRX_ERRORS |
502 KVASER_HAS_SILENT_MODE },
503 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_PRO_LS_PRODUCT_ID),
504 .driver_info = KVASER_HAS_TXRX_ERRORS |
505 KVASER_HAS_SILENT_MODE },
506 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_PRO_SWC_PRODUCT_ID),
507 .driver_info = KVASER_HAS_TXRX_ERRORS |
508 KVASER_HAS_SILENT_MODE },
509 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_PRO_LIN_PRODUCT_ID),
510 .driver_info = KVASER_HAS_TXRX_ERRORS |
511 KVASER_HAS_SILENT_MODE },
512 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_SPRO_LS_PRODUCT_ID),
513 .driver_info = KVASER_HAS_TXRX_ERRORS |
514 KVASER_HAS_SILENT_MODE },
515 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_SPRO_SWC_PRODUCT_ID),
516 .driver_info = KVASER_HAS_TXRX_ERRORS |
517 KVASER_HAS_SILENT_MODE },
518 { USB_DEVICE(KVASER_VENDOR_ID, USB_MEMO2_DEVEL_PRODUCT_ID),
519 .driver_info = KVASER_HAS_TXRX_ERRORS |
520 KVASER_HAS_SILENT_MODE },
521 { USB_DEVICE(KVASER_VENDOR_ID, USB_MEMO2_HSHS_PRODUCT_ID),
522 .driver_info = KVASER_HAS_TXRX_ERRORS |
523 KVASER_HAS_SILENT_MODE },
524 { USB_DEVICE(KVASER_VENDOR_ID, USB_UPRO_HSHS_PRODUCT_ID),
525 .driver_info = KVASER_HAS_TXRX_ERRORS },
526 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_LITE_GI_PRODUCT_ID) },
527 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_PRO_OBDII_PRODUCT_ID),
528 .driver_info = KVASER_HAS_TXRX_ERRORS |
529 KVASER_HAS_SILENT_MODE },
530 { USB_DEVICE(KVASER_VENDOR_ID, USB_MEMO2_HSLS_PRODUCT_ID),
531 .driver_info = KVASER_HAS_TXRX_ERRORS },
532 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_LITE_CH_PRODUCT_ID),
533 .driver_info = KVASER_HAS_TXRX_ERRORS },
534 { USB_DEVICE(KVASER_VENDOR_ID, USB_BLACKBIRD_SPRO_PRODUCT_ID),
535 .driver_info = KVASER_HAS_TXRX_ERRORS },
536 { USB_DEVICE(KVASER_VENDOR_ID, USB_OEM_MERCURY_PRODUCT_ID),
537 .driver_info = KVASER_HAS_TXRX_ERRORS },
538 { USB_DEVICE(KVASER_VENDOR_ID, USB_OEM_LEAF_PRODUCT_ID),
539 .driver_info = KVASER_HAS_TXRX_ERRORS },
540 { USB_DEVICE(KVASER_VENDOR_ID, USB_CAN_R_PRODUCT_ID),
541 .driver_info = KVASER_HAS_TXRX_ERRORS },
542 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_LITE_V2_PRODUCT_ID) },
543 { USB_DEVICE(KVASER_VENDOR_ID, USB_MINI_PCIE_HS_PRODUCT_ID) },
544 { USB_DEVICE(KVASER_VENDOR_ID, USB_LEAF_LIGHT_HS_V2_OEM_PRODUCT_ID) },
545 { USB_DEVICE(KVASER_VENDOR_ID, USB_USBCAN_LIGHT_2HS_PRODUCT_ID) },
546 { USB_DEVICE(KVASER_VENDOR_ID, USB_MINI_PCIE_2HS_PRODUCT_ID) },
548 /* USBCANII family IDs */
549 { USB_DEVICE(KVASER_VENDOR_ID, USB_USBCAN2_PRODUCT_ID),
550 .driver_info = KVASER_HAS_TXRX_ERRORS },
551 { USB_DEVICE(KVASER_VENDOR_ID, USB_USBCAN_REVB_PRODUCT_ID),
552 .driver_info = KVASER_HAS_TXRX_ERRORS },
553 { USB_DEVICE(KVASER_VENDOR_ID, USB_MEMORATOR_PRODUCT_ID),
554 .driver_info = KVASER_HAS_TXRX_ERRORS },
555 { USB_DEVICE(KVASER_VENDOR_ID, USB_VCI2_PRODUCT_ID),
556 .driver_info = KVASER_HAS_TXRX_ERRORS },
560 MODULE_DEVICE_TABLE(usb, kvaser_usb_table);
562 static inline int kvaser_usb_send_msg(const struct kvaser_usb *dev,
563 struct kvaser_msg *msg)
567 return usb_bulk_msg(dev->udev,
568 usb_sndbulkpipe(dev->udev,
569 dev->bulk_out->bEndpointAddress),
570 msg, msg->len, &actual_len,
574 static int kvaser_usb_wait_msg(const struct kvaser_usb *dev, u8 id,
575 struct kvaser_msg *msg)
577 struct kvaser_msg *tmp;
582 unsigned long to = jiffies + msecs_to_jiffies(USB_RECV_TIMEOUT);
584 buf = kzalloc(RX_BUFFER_SIZE, GFP_KERNEL);
589 err = usb_bulk_msg(dev->udev,
590 usb_rcvbulkpipe(dev->udev,
591 dev->bulk_in->bEndpointAddress),
592 buf, RX_BUFFER_SIZE, &actual_len,
598 while (pos <= actual_len - MSG_HEADER_LEN) {
601 /* Handle messages crossing the USB endpoint max packet
602 * size boundary. Check kvaser_usb_read_bulk_callback()
603 * for further details.
606 pos = round_up(pos, le16_to_cpu(dev->bulk_in->
611 if (pos + tmp->len > actual_len) {
612 dev_err(dev->udev->dev.parent,
618 memcpy(msg, tmp, tmp->len);
624 } while (time_before(jiffies, to));
634 static int kvaser_usb_send_simple_msg(const struct kvaser_usb *dev,
635 u8 msg_id, int channel)
637 struct kvaser_msg *msg;
640 msg = kmalloc(sizeof(*msg), GFP_KERNEL);
645 msg->len = MSG_HEADER_LEN + sizeof(struct kvaser_msg_simple);
646 msg->u.simple.channel = channel;
647 msg->u.simple.tid = 0xff;
649 rc = kvaser_usb_send_msg(dev, msg);
655 static int kvaser_usb_get_software_info(struct kvaser_usb *dev)
657 struct kvaser_msg msg;
660 err = kvaser_usb_send_simple_msg(dev, CMD_GET_SOFTWARE_INFO, 0);
664 err = kvaser_usb_wait_msg(dev, CMD_GET_SOFTWARE_INFO_REPLY, &msg);
668 switch (dev->family) {
670 dev->fw_version = le32_to_cpu(msg.u.leaf.softinfo.fw_version);
672 le16_to_cpu(msg.u.leaf.softinfo.max_outstanding_tx);
675 dev->fw_version = le32_to_cpu(msg.u.usbcan.softinfo.fw_version);
677 le16_to_cpu(msg.u.usbcan.softinfo.max_outstanding_tx);
684 static int kvaser_usb_get_card_info(struct kvaser_usb *dev)
686 struct kvaser_msg msg;
689 err = kvaser_usb_send_simple_msg(dev, CMD_GET_CARD_INFO, 0);
693 err = kvaser_usb_wait_msg(dev, CMD_GET_CARD_INFO_REPLY, &msg);
697 dev->nchannels = msg.u.cardinfo.nchannels;
698 if ((dev->nchannels > MAX_NET_DEVICES) ||
699 (dev->family == KVASER_USBCAN &&
700 dev->nchannels > MAX_USBCAN_NET_DEVICES))
706 static void kvaser_usb_tx_acknowledge(const struct kvaser_usb *dev,
707 const struct kvaser_msg *msg)
709 struct net_device_stats *stats;
710 struct kvaser_usb_tx_urb_context *context;
711 struct kvaser_usb_net_priv *priv;
713 struct can_frame *cf;
717 channel = msg->u.tx_acknowledge_header.channel;
718 tid = msg->u.tx_acknowledge_header.tid;
720 if (channel >= dev->nchannels) {
721 dev_err(dev->udev->dev.parent,
722 "Invalid channel number (%d)\n", channel);
726 priv = dev->nets[channel];
728 if (!netif_device_present(priv->netdev))
731 stats = &priv->netdev->stats;
733 context = &priv->tx_contexts[tid % dev->max_tx_urbs];
735 /* Sometimes the state change doesn't come after a bus-off event */
736 if (priv->can.restart_ms &&
737 (priv->can.state >= CAN_STATE_BUS_OFF)) {
738 skb = alloc_can_err_skb(priv->netdev, &cf);
740 cf->can_id |= CAN_ERR_RESTARTED;
743 stats->rx_bytes += cf->can_dlc;
746 netdev_err(priv->netdev,
747 "No memory left for err_skb\n");
750 priv->can.can_stats.restarts++;
751 netif_carrier_on(priv->netdev);
753 priv->can.state = CAN_STATE_ERROR_ACTIVE;
757 stats->tx_bytes += context->dlc;
759 spin_lock_irqsave(&priv->tx_contexts_lock, flags);
761 can_get_echo_skb(priv->netdev, context->echo_index);
762 context->echo_index = dev->max_tx_urbs;
763 --priv->active_tx_contexts;
764 netif_wake_queue(priv->netdev);
766 spin_unlock_irqrestore(&priv->tx_contexts_lock, flags);
769 static void kvaser_usb_simple_msg_callback(struct urb *urb)
771 struct net_device *netdev = urb->context;
773 kfree(urb->transfer_buffer);
776 netdev_warn(netdev, "urb status received: %d\n",
780 static int kvaser_usb_simple_msg_async(struct kvaser_usb_net_priv *priv,
783 struct kvaser_usb *dev = priv->dev;
784 struct net_device *netdev = priv->netdev;
785 struct kvaser_msg *msg;
790 urb = usb_alloc_urb(0, GFP_ATOMIC);
794 buf = kmalloc(sizeof(struct kvaser_msg), GFP_ATOMIC);
800 msg = (struct kvaser_msg *)buf;
801 msg->len = MSG_HEADER_LEN + sizeof(struct kvaser_msg_simple);
803 msg->u.simple.channel = priv->channel;
805 usb_fill_bulk_urb(urb, dev->udev,
806 usb_sndbulkpipe(dev->udev,
807 dev->bulk_out->bEndpointAddress),
809 kvaser_usb_simple_msg_callback, netdev);
810 usb_anchor_urb(urb, &priv->tx_submitted);
812 err = usb_submit_urb(urb, GFP_ATOMIC);
814 netdev_err(netdev, "Error transmitting URB\n");
815 usb_unanchor_urb(urb);
825 static void kvaser_usb_rx_error_update_can_state(struct kvaser_usb_net_priv *priv,
826 const struct kvaser_usb_error_summary *es,
827 struct can_frame *cf)
829 struct kvaser_usb *dev = priv->dev;
830 struct net_device_stats *stats = &priv->netdev->stats;
831 enum can_state cur_state, new_state, tx_state, rx_state;
833 netdev_dbg(priv->netdev, "Error status: 0x%02x\n", es->status);
835 new_state = cur_state = priv->can.state;
837 if (es->status & (M16C_STATE_BUS_OFF | M16C_STATE_BUS_RESET))
838 new_state = CAN_STATE_BUS_OFF;
839 else if (es->status & M16C_STATE_BUS_PASSIVE)
840 new_state = CAN_STATE_ERROR_PASSIVE;
841 else if (es->status & M16C_STATE_BUS_ERROR) {
842 /* Guard against spurious error events after a busoff */
843 if (cur_state < CAN_STATE_BUS_OFF) {
844 if ((es->txerr >= 128) || (es->rxerr >= 128))
845 new_state = CAN_STATE_ERROR_PASSIVE;
846 else if ((es->txerr >= 96) || (es->rxerr >= 96))
847 new_state = CAN_STATE_ERROR_WARNING;
848 else if (cur_state > CAN_STATE_ERROR_ACTIVE)
849 new_state = CAN_STATE_ERROR_ACTIVE;
854 new_state = CAN_STATE_ERROR_ACTIVE;
856 if (new_state != cur_state) {
857 tx_state = (es->txerr >= es->rxerr) ? new_state : 0;
858 rx_state = (es->txerr <= es->rxerr) ? new_state : 0;
860 can_change_state(priv->netdev, cf, tx_state, rx_state);
863 if (priv->can.restart_ms &&
864 (cur_state >= CAN_STATE_BUS_OFF) &&
865 (new_state < CAN_STATE_BUS_OFF)) {
866 priv->can.can_stats.restarts++;
869 switch (dev->family) {
871 if (es->leaf.error_factor) {
872 priv->can.can_stats.bus_error++;
877 if (es->usbcan.error_state & USBCAN_ERROR_STATE_TX_ERROR)
879 if (es->usbcan.error_state & USBCAN_ERROR_STATE_RX_ERROR)
881 if (es->usbcan.error_state & USBCAN_ERROR_STATE_BUSERROR) {
882 priv->can.can_stats.bus_error++;
887 priv->bec.txerr = es->txerr;
888 priv->bec.rxerr = es->rxerr;
891 static void kvaser_usb_rx_error(const struct kvaser_usb *dev,
892 const struct kvaser_usb_error_summary *es)
894 struct can_frame *cf, tmp_cf = { .can_id = CAN_ERR_FLAG, .can_dlc = CAN_ERR_DLC };
896 struct net_device_stats *stats;
897 struct kvaser_usb_net_priv *priv;
898 enum can_state old_state, new_state;
900 if (es->channel >= dev->nchannels) {
901 dev_err(dev->udev->dev.parent,
902 "Invalid channel number (%d)\n", es->channel);
906 priv = dev->nets[es->channel];
907 stats = &priv->netdev->stats;
909 /* Update all of the can interface's state and error counters before
910 * trying any memory allocation that can actually fail with -ENOMEM.
912 * We send a temporary stack-allocated error can frame to
913 * can_change_state() for the very same reason.
915 * TODO: Split can_change_state() responsibility between updating the
916 * can interface's state and counters, and the setting up of can error
917 * frame ID and data to userspace. Remove stack allocation afterwards.
919 old_state = priv->can.state;
920 kvaser_usb_rx_error_update_can_state(priv, es, &tmp_cf);
921 new_state = priv->can.state;
923 skb = alloc_can_err_skb(priv->netdev, &cf);
928 memcpy(cf, &tmp_cf, sizeof(*cf));
930 if (new_state != old_state) {
932 (M16C_STATE_BUS_OFF | M16C_STATE_BUS_RESET)) {
933 if (!priv->can.restart_ms)
934 kvaser_usb_simple_msg_async(priv, CMD_STOP_CHIP);
935 netif_carrier_off(priv->netdev);
938 if (priv->can.restart_ms &&
939 (old_state >= CAN_STATE_BUS_OFF) &&
940 (new_state < CAN_STATE_BUS_OFF)) {
941 cf->can_id |= CAN_ERR_RESTARTED;
942 netif_carrier_on(priv->netdev);
946 switch (dev->family) {
948 if (es->leaf.error_factor) {
949 cf->can_id |= CAN_ERR_BUSERROR | CAN_ERR_PROT;
951 if (es->leaf.error_factor & M16C_EF_ACKE)
952 cf->data[3] = CAN_ERR_PROT_LOC_ACK;
953 if (es->leaf.error_factor & M16C_EF_CRCE)
954 cf->data[3] = CAN_ERR_PROT_LOC_CRC_SEQ;
955 if (es->leaf.error_factor & M16C_EF_FORME)
956 cf->data[2] |= CAN_ERR_PROT_FORM;
957 if (es->leaf.error_factor & M16C_EF_STFE)
958 cf->data[2] |= CAN_ERR_PROT_STUFF;
959 if (es->leaf.error_factor & M16C_EF_BITE0)
960 cf->data[2] |= CAN_ERR_PROT_BIT0;
961 if (es->leaf.error_factor & M16C_EF_BITE1)
962 cf->data[2] |= CAN_ERR_PROT_BIT1;
963 if (es->leaf.error_factor & M16C_EF_TRE)
964 cf->data[2] |= CAN_ERR_PROT_TX;
968 if (es->usbcan.error_state & USBCAN_ERROR_STATE_BUSERROR) {
969 cf->can_id |= CAN_ERR_BUSERROR;
974 cf->data[6] = es->txerr;
975 cf->data[7] = es->rxerr;
978 stats->rx_bytes += cf->can_dlc;
982 /* For USBCAN, report error to userspace iff the channels's errors counter
983 * has changed, or we're the only channel seeing a bus error state.
985 static void kvaser_usbcan_conditionally_rx_error(const struct kvaser_usb *dev,
986 struct kvaser_usb_error_summary *es)
988 struct kvaser_usb_net_priv *priv;
992 channel = es->channel;
993 if (channel >= dev->nchannels) {
994 dev_err(dev->udev->dev.parent,
995 "Invalid channel number (%d)\n", channel);
999 priv = dev->nets[channel];
1000 report_error = false;
1002 if (es->txerr != priv->bec.txerr) {
1003 es->usbcan.error_state |= USBCAN_ERROR_STATE_TX_ERROR;
1004 report_error = true;
1006 if (es->rxerr != priv->bec.rxerr) {
1007 es->usbcan.error_state |= USBCAN_ERROR_STATE_RX_ERROR;
1008 report_error = true;
1010 if ((es->status & M16C_STATE_BUS_ERROR) &&
1011 !(es->usbcan.other_ch_status & M16C_STATE_BUS_ERROR)) {
1012 es->usbcan.error_state |= USBCAN_ERROR_STATE_BUSERROR;
1013 report_error = true;
1017 kvaser_usb_rx_error(dev, es);
1020 static void kvaser_usbcan_rx_error(const struct kvaser_usb *dev,
1021 const struct kvaser_msg *msg)
1023 struct kvaser_usb_error_summary es = { };
1026 /* Sometimes errors are sent as unsolicited chip state events */
1027 case CMD_CHIP_STATE_EVENT:
1028 es.channel = msg->u.usbcan.chip_state_event.channel;
1029 es.status = msg->u.usbcan.chip_state_event.status;
1030 es.txerr = msg->u.usbcan.chip_state_event.tx_errors_count;
1031 es.rxerr = msg->u.usbcan.chip_state_event.rx_errors_count;
1032 kvaser_usbcan_conditionally_rx_error(dev, &es);
1035 case CMD_CAN_ERROR_EVENT:
1037 es.status = msg->u.usbcan.error_event.status_ch0;
1038 es.txerr = msg->u.usbcan.error_event.tx_errors_count_ch0;
1039 es.rxerr = msg->u.usbcan.error_event.rx_errors_count_ch0;
1040 es.usbcan.other_ch_status =
1041 msg->u.usbcan.error_event.status_ch1;
1042 kvaser_usbcan_conditionally_rx_error(dev, &es);
1044 /* The USBCAN firmware supports up to 2 channels.
1045 * Now that ch0 was checked, check if ch1 has any errors.
1047 if (dev->nchannels == MAX_USBCAN_NET_DEVICES) {
1049 es.status = msg->u.usbcan.error_event.status_ch1;
1050 es.txerr = msg->u.usbcan.error_event.tx_errors_count_ch1;
1051 es.rxerr = msg->u.usbcan.error_event.rx_errors_count_ch1;
1052 es.usbcan.other_ch_status =
1053 msg->u.usbcan.error_event.status_ch0;
1054 kvaser_usbcan_conditionally_rx_error(dev, &es);
1059 dev_err(dev->udev->dev.parent, "Invalid msg id (%d)\n",
1064 static void kvaser_leaf_rx_error(const struct kvaser_usb *dev,
1065 const struct kvaser_msg *msg)
1067 struct kvaser_usb_error_summary es = { };
1070 case CMD_CAN_ERROR_EVENT:
1071 es.channel = msg->u.leaf.error_event.channel;
1072 es.status = msg->u.leaf.error_event.status;
1073 es.txerr = msg->u.leaf.error_event.tx_errors_count;
1074 es.rxerr = msg->u.leaf.error_event.rx_errors_count;
1075 es.leaf.error_factor = msg->u.leaf.error_event.error_factor;
1077 case CMD_LEAF_LOG_MESSAGE:
1078 es.channel = msg->u.leaf.log_message.channel;
1079 es.status = msg->u.leaf.log_message.data[0];
1080 es.txerr = msg->u.leaf.log_message.data[2];
1081 es.rxerr = msg->u.leaf.log_message.data[3];
1082 es.leaf.error_factor = msg->u.leaf.log_message.data[1];
1084 case CMD_CHIP_STATE_EVENT:
1085 es.channel = msg->u.leaf.chip_state_event.channel;
1086 es.status = msg->u.leaf.chip_state_event.status;
1087 es.txerr = msg->u.leaf.chip_state_event.tx_errors_count;
1088 es.rxerr = msg->u.leaf.chip_state_event.rx_errors_count;
1089 es.leaf.error_factor = 0;
1092 dev_err(dev->udev->dev.parent, "Invalid msg id (%d)\n",
1097 kvaser_usb_rx_error(dev, &es);
1100 static void kvaser_usb_rx_can_err(const struct kvaser_usb_net_priv *priv,
1101 const struct kvaser_msg *msg)
1103 struct can_frame *cf;
1104 struct sk_buff *skb;
1105 struct net_device_stats *stats = &priv->netdev->stats;
1107 if (msg->u.rx_can_header.flag & (MSG_FLAG_ERROR_FRAME |
1109 netdev_err(priv->netdev, "Unknown error (flags: 0x%02x)\n",
1110 msg->u.rx_can_header.flag);
1116 if (msg->u.rx_can_header.flag & MSG_FLAG_OVERRUN) {
1117 stats->rx_over_errors++;
1120 skb = alloc_can_err_skb(priv->netdev, &cf);
1122 stats->rx_dropped++;
1126 cf->can_id |= CAN_ERR_CRTL;
1127 cf->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
1129 stats->rx_packets++;
1130 stats->rx_bytes += cf->can_dlc;
1135 static void kvaser_usb_rx_can_msg(const struct kvaser_usb *dev,
1136 const struct kvaser_msg *msg)
1138 struct kvaser_usb_net_priv *priv;
1139 struct can_frame *cf;
1140 struct sk_buff *skb;
1141 struct net_device_stats *stats;
1142 u8 channel = msg->u.rx_can_header.channel;
1143 const u8 *rx_msg = NULL; /* GCC */
1145 if (channel >= dev->nchannels) {
1146 dev_err(dev->udev->dev.parent,
1147 "Invalid channel number (%d)\n", channel);
1151 priv = dev->nets[channel];
1152 stats = &priv->netdev->stats;
1154 if ((msg->u.rx_can_header.flag & MSG_FLAG_ERROR_FRAME) &&
1155 (dev->family == KVASER_LEAF && msg->id == CMD_LEAF_LOG_MESSAGE)) {
1156 kvaser_leaf_rx_error(dev, msg);
1158 } else if (msg->u.rx_can_header.flag & (MSG_FLAG_ERROR_FRAME |
1160 MSG_FLAG_OVERRUN)) {
1161 kvaser_usb_rx_can_err(priv, msg);
1163 } else if (msg->u.rx_can_header.flag & ~MSG_FLAG_REMOTE_FRAME) {
1164 netdev_warn(priv->netdev,
1165 "Unhandled frame (flags: 0x%02x)",
1166 msg->u.rx_can_header.flag);
1170 switch (dev->family) {
1172 rx_msg = msg->u.leaf.rx_can.msg;
1175 rx_msg = msg->u.usbcan.rx_can.msg;
1179 skb = alloc_can_skb(priv->netdev, &cf);
1181 stats->tx_dropped++;
1185 if (dev->family == KVASER_LEAF && msg->id == CMD_LEAF_LOG_MESSAGE) {
1186 cf->can_id = le32_to_cpu(msg->u.leaf.log_message.id);
1187 if (cf->can_id & KVASER_EXTENDED_FRAME)
1188 cf->can_id &= CAN_EFF_MASK | CAN_EFF_FLAG;
1190 cf->can_id &= CAN_SFF_MASK;
1192 cf->can_dlc = get_can_dlc(msg->u.leaf.log_message.dlc);
1194 if (msg->u.leaf.log_message.flags & MSG_FLAG_REMOTE_FRAME)
1195 cf->can_id |= CAN_RTR_FLAG;
1197 memcpy(cf->data, &msg->u.leaf.log_message.data,
1200 cf->can_id = ((rx_msg[0] & 0x1f) << 6) | (rx_msg[1] & 0x3f);
1202 if (msg->id == CMD_RX_EXT_MESSAGE) {
1204 cf->can_id |= ((rx_msg[2] & 0x0f) << 14) |
1205 ((rx_msg[3] & 0xff) << 6) |
1207 cf->can_id |= CAN_EFF_FLAG;
1210 cf->can_dlc = get_can_dlc(rx_msg[5]);
1212 if (msg->u.rx_can_header.flag & MSG_FLAG_REMOTE_FRAME)
1213 cf->can_id |= CAN_RTR_FLAG;
1215 memcpy(cf->data, &rx_msg[6],
1219 stats->rx_packets++;
1220 stats->rx_bytes += cf->can_dlc;
1224 static void kvaser_usb_start_chip_reply(const struct kvaser_usb *dev,
1225 const struct kvaser_msg *msg)
1227 struct kvaser_usb_net_priv *priv;
1228 u8 channel = msg->u.simple.channel;
1230 if (channel >= dev->nchannels) {
1231 dev_err(dev->udev->dev.parent,
1232 "Invalid channel number (%d)\n", channel);
1236 priv = dev->nets[channel];
1238 if (completion_done(&priv->start_comp) &&
1239 netif_queue_stopped(priv->netdev)) {
1240 netif_wake_queue(priv->netdev);
1242 netif_start_queue(priv->netdev);
1243 complete(&priv->start_comp);
1247 static void kvaser_usb_stop_chip_reply(const struct kvaser_usb *dev,
1248 const struct kvaser_msg *msg)
1250 struct kvaser_usb_net_priv *priv;
1251 u8 channel = msg->u.simple.channel;
1253 if (channel >= dev->nchannels) {
1254 dev_err(dev->udev->dev.parent,
1255 "Invalid channel number (%d)\n", channel);
1259 priv = dev->nets[channel];
1261 complete(&priv->stop_comp);
1264 static void kvaser_usb_handle_message(const struct kvaser_usb *dev,
1265 const struct kvaser_msg *msg)
1268 case CMD_START_CHIP_REPLY:
1269 kvaser_usb_start_chip_reply(dev, msg);
1272 case CMD_STOP_CHIP_REPLY:
1273 kvaser_usb_stop_chip_reply(dev, msg);
1276 case CMD_RX_STD_MESSAGE:
1277 case CMD_RX_EXT_MESSAGE:
1278 kvaser_usb_rx_can_msg(dev, msg);
1281 case CMD_LEAF_LOG_MESSAGE:
1282 if (dev->family != KVASER_LEAF)
1284 kvaser_usb_rx_can_msg(dev, msg);
1287 case CMD_CHIP_STATE_EVENT:
1288 case CMD_CAN_ERROR_EVENT:
1289 if (dev->family == KVASER_LEAF)
1290 kvaser_leaf_rx_error(dev, msg);
1292 kvaser_usbcan_rx_error(dev, msg);
1295 case CMD_TX_ACKNOWLEDGE:
1296 kvaser_usb_tx_acknowledge(dev, msg);
1299 /* Ignored messages */
1300 case CMD_USBCAN_CLOCK_OVERFLOW_EVENT:
1301 if (dev->family != KVASER_USBCAN)
1305 case CMD_FLUSH_QUEUE_REPLY:
1306 if (dev->family != KVASER_LEAF)
1311 warn: dev_warn(dev->udev->dev.parent,
1312 "Unhandled message (%d)\n", msg->id);
1317 static void kvaser_usb_read_bulk_callback(struct urb *urb)
1319 struct kvaser_usb *dev = urb->context;
1320 struct kvaser_msg *msg;
1324 switch (urb->status) {
1331 dev_info(dev->udev->dev.parent, "Rx URB aborted (%d)\n",
1336 while (pos <= urb->actual_length - MSG_HEADER_LEN) {
1337 msg = urb->transfer_buffer + pos;
1339 /* The Kvaser firmware can only read and write messages that
1340 * does not cross the USB's endpoint wMaxPacketSize boundary.
1341 * If a follow-up command crosses such boundary, firmware puts
1342 * a placeholder zero-length command in its place then aligns
1343 * the real command to the next max packet size.
1345 * Handle such cases or we're going to miss a significant
1346 * number of events in case of a heavy rx load on the bus.
1348 if (msg->len == 0) {
1349 pos = round_up(pos, le16_to_cpu(dev->bulk_in->
1354 if (pos + msg->len > urb->actual_length) {
1355 dev_err(dev->udev->dev.parent, "Format error\n");
1359 kvaser_usb_handle_message(dev, msg);
1364 usb_fill_bulk_urb(urb, dev->udev,
1365 usb_rcvbulkpipe(dev->udev,
1366 dev->bulk_in->bEndpointAddress),
1367 urb->transfer_buffer, RX_BUFFER_SIZE,
1368 kvaser_usb_read_bulk_callback, dev);
1370 err = usb_submit_urb(urb, GFP_ATOMIC);
1371 if (err == -ENODEV) {
1372 for (i = 0; i < dev->nchannels; i++) {
1376 netif_device_detach(dev->nets[i]->netdev);
1379 dev_err(dev->udev->dev.parent,
1380 "Failed resubmitting read bulk urb: %d\n", err);
1386 static int kvaser_usb_setup_rx_urbs(struct kvaser_usb *dev)
1390 if (dev->rxinitdone)
1393 for (i = 0; i < MAX_RX_URBS; i++) {
1394 struct urb *urb = NULL;
1398 urb = usb_alloc_urb(0, GFP_KERNEL);
1404 buf = usb_alloc_coherent(dev->udev, RX_BUFFER_SIZE,
1405 GFP_KERNEL, &buf_dma);
1407 dev_warn(dev->udev->dev.parent,
1408 "No memory left for USB buffer\n");
1414 usb_fill_bulk_urb(urb, dev->udev,
1415 usb_rcvbulkpipe(dev->udev,
1416 dev->bulk_in->bEndpointAddress),
1417 buf, RX_BUFFER_SIZE,
1418 kvaser_usb_read_bulk_callback,
1420 urb->transfer_dma = buf_dma;
1421 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1422 usb_anchor_urb(urb, &dev->rx_submitted);
1424 err = usb_submit_urb(urb, GFP_KERNEL);
1426 usb_unanchor_urb(urb);
1427 usb_free_coherent(dev->udev, RX_BUFFER_SIZE, buf,
1433 dev->rxbuf[i] = buf;
1434 dev->rxbuf_dma[i] = buf_dma;
1440 dev_warn(dev->udev->dev.parent,
1441 "Cannot setup read URBs, error %d\n", err);
1443 } else if (i < MAX_RX_URBS) {
1444 dev_warn(dev->udev->dev.parent,
1445 "RX performances may be slow\n");
1448 dev->rxinitdone = true;
1453 static int kvaser_usb_set_opt_mode(const struct kvaser_usb_net_priv *priv)
1455 struct kvaser_msg *msg;
1458 msg = kmalloc(sizeof(*msg), GFP_KERNEL);
1462 msg->id = CMD_SET_CTRL_MODE;
1463 msg->len = MSG_HEADER_LEN + sizeof(struct kvaser_msg_ctrl_mode);
1464 msg->u.ctrl_mode.tid = 0xff;
1465 msg->u.ctrl_mode.channel = priv->channel;
1467 if (priv->can.ctrlmode & CAN_CTRLMODE_LISTENONLY)
1468 msg->u.ctrl_mode.ctrl_mode = KVASER_CTRL_MODE_SILENT;
1470 msg->u.ctrl_mode.ctrl_mode = KVASER_CTRL_MODE_NORMAL;
1472 rc = kvaser_usb_send_msg(priv->dev, msg);
1478 static int kvaser_usb_start_chip(struct kvaser_usb_net_priv *priv)
1482 init_completion(&priv->start_comp);
1484 err = kvaser_usb_send_simple_msg(priv->dev, CMD_START_CHIP,
1489 if (!wait_for_completion_timeout(&priv->start_comp,
1490 msecs_to_jiffies(START_TIMEOUT)))
1496 static int kvaser_usb_open(struct net_device *netdev)
1498 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1499 struct kvaser_usb *dev = priv->dev;
1502 err = open_candev(netdev);
1506 err = kvaser_usb_setup_rx_urbs(dev);
1510 err = kvaser_usb_set_opt_mode(priv);
1514 err = kvaser_usb_start_chip(priv);
1516 netdev_warn(netdev, "Cannot start device, error %d\n", err);
1520 priv->can.state = CAN_STATE_ERROR_ACTIVE;
1525 close_candev(netdev);
1529 static void kvaser_usb_reset_tx_urb_contexts(struct kvaser_usb_net_priv *priv)
1533 max_tx_urbs = priv->dev->max_tx_urbs;
1535 priv->active_tx_contexts = 0;
1536 for (i = 0; i < max_tx_urbs; i++)
1537 priv->tx_contexts[i].echo_index = max_tx_urbs;
1540 /* This method might sleep. Do not call it in the atomic context
1541 * of URB completions.
1543 static void kvaser_usb_unlink_tx_urbs(struct kvaser_usb_net_priv *priv)
1545 usb_kill_anchored_urbs(&priv->tx_submitted);
1546 kvaser_usb_reset_tx_urb_contexts(priv);
1549 static void kvaser_usb_unlink_all_urbs(struct kvaser_usb *dev)
1553 usb_kill_anchored_urbs(&dev->rx_submitted);
1555 for (i = 0; i < MAX_RX_URBS; i++)
1556 usb_free_coherent(dev->udev, RX_BUFFER_SIZE,
1560 for (i = 0; i < dev->nchannels; i++) {
1561 struct kvaser_usb_net_priv *priv = dev->nets[i];
1564 kvaser_usb_unlink_tx_urbs(priv);
1568 static int kvaser_usb_stop_chip(struct kvaser_usb_net_priv *priv)
1572 init_completion(&priv->stop_comp);
1574 err = kvaser_usb_send_simple_msg(priv->dev, CMD_STOP_CHIP,
1579 if (!wait_for_completion_timeout(&priv->stop_comp,
1580 msecs_to_jiffies(STOP_TIMEOUT)))
1586 static int kvaser_usb_flush_queue(struct kvaser_usb_net_priv *priv)
1588 struct kvaser_msg *msg;
1591 msg = kmalloc(sizeof(*msg), GFP_KERNEL);
1595 msg->id = CMD_FLUSH_QUEUE;
1596 msg->len = MSG_HEADER_LEN + sizeof(struct kvaser_msg_flush_queue);
1597 msg->u.flush_queue.channel = priv->channel;
1598 msg->u.flush_queue.flags = 0x00;
1600 rc = kvaser_usb_send_msg(priv->dev, msg);
1606 static int kvaser_usb_close(struct net_device *netdev)
1608 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1609 struct kvaser_usb *dev = priv->dev;
1612 netif_stop_queue(netdev);
1614 err = kvaser_usb_flush_queue(priv);
1616 netdev_warn(netdev, "Cannot flush queue, error %d\n", err);
1618 err = kvaser_usb_send_simple_msg(dev, CMD_RESET_CHIP, priv->channel);
1620 netdev_warn(netdev, "Cannot reset card, error %d\n", err);
1622 err = kvaser_usb_stop_chip(priv);
1624 netdev_warn(netdev, "Cannot stop device, error %d\n", err);
1626 /* reset tx contexts */
1627 kvaser_usb_unlink_tx_urbs(priv);
1629 priv->can.state = CAN_STATE_STOPPED;
1630 close_candev(priv->netdev);
1635 static void kvaser_usb_write_bulk_callback(struct urb *urb)
1637 struct kvaser_usb_tx_urb_context *context = urb->context;
1638 struct kvaser_usb_net_priv *priv;
1639 struct net_device *netdev;
1641 if (WARN_ON(!context))
1644 priv = context->priv;
1645 netdev = priv->netdev;
1647 kfree(urb->transfer_buffer);
1649 if (!netif_device_present(netdev))
1653 netdev_info(netdev, "Tx URB aborted (%d)\n", urb->status);
1656 static netdev_tx_t kvaser_usb_start_xmit(struct sk_buff *skb,
1657 struct net_device *netdev)
1659 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1660 struct kvaser_usb *dev = priv->dev;
1661 struct net_device_stats *stats = &netdev->stats;
1662 struct can_frame *cf = (struct can_frame *)skb->data;
1663 struct kvaser_usb_tx_urb_context *context = NULL;
1666 struct kvaser_msg *msg;
1667 int i, err, ret = NETDEV_TX_OK;
1668 u8 *msg_tx_can_flags = NULL; /* GCC */
1669 unsigned long flags;
1671 if (can_dropped_invalid_skb(netdev, skb))
1672 return NETDEV_TX_OK;
1674 urb = usb_alloc_urb(0, GFP_ATOMIC);
1676 stats->tx_dropped++;
1678 return NETDEV_TX_OK;
1681 buf = kmalloc(sizeof(struct kvaser_msg), GFP_ATOMIC);
1683 stats->tx_dropped++;
1689 msg->len = MSG_HEADER_LEN + sizeof(struct kvaser_msg_tx_can);
1690 msg->u.tx_can.channel = priv->channel;
1692 switch (dev->family) {
1694 msg_tx_can_flags = &msg->u.tx_can.leaf.flags;
1697 msg_tx_can_flags = &msg->u.tx_can.usbcan.flags;
1701 *msg_tx_can_flags = 0;
1703 if (cf->can_id & CAN_EFF_FLAG) {
1704 msg->id = CMD_TX_EXT_MESSAGE;
1705 msg->u.tx_can.msg[0] = (cf->can_id >> 24) & 0x1f;
1706 msg->u.tx_can.msg[1] = (cf->can_id >> 18) & 0x3f;
1707 msg->u.tx_can.msg[2] = (cf->can_id >> 14) & 0x0f;
1708 msg->u.tx_can.msg[3] = (cf->can_id >> 6) & 0xff;
1709 msg->u.tx_can.msg[4] = cf->can_id & 0x3f;
1711 msg->id = CMD_TX_STD_MESSAGE;
1712 msg->u.tx_can.msg[0] = (cf->can_id >> 6) & 0x1f;
1713 msg->u.tx_can.msg[1] = cf->can_id & 0x3f;
1716 msg->u.tx_can.msg[5] = cf->can_dlc;
1717 memcpy(&msg->u.tx_can.msg[6], cf->data, cf->can_dlc);
1719 if (cf->can_id & CAN_RTR_FLAG)
1720 *msg_tx_can_flags |= MSG_FLAG_REMOTE_FRAME;
1722 spin_lock_irqsave(&priv->tx_contexts_lock, flags);
1723 for (i = 0; i < dev->max_tx_urbs; i++) {
1724 if (priv->tx_contexts[i].echo_index == dev->max_tx_urbs) {
1725 context = &priv->tx_contexts[i];
1727 context->echo_index = i;
1728 can_put_echo_skb(skb, netdev, context->echo_index);
1729 ++priv->active_tx_contexts;
1730 if (priv->active_tx_contexts >= dev->max_tx_urbs)
1731 netif_stop_queue(netdev);
1736 spin_unlock_irqrestore(&priv->tx_contexts_lock, flags);
1738 /* This should never happen; it implies a flow control bug */
1740 netdev_warn(netdev, "cannot find free context\n");
1743 ret = NETDEV_TX_BUSY;
1747 context->priv = priv;
1748 context->dlc = cf->can_dlc;
1750 msg->u.tx_can.tid = context->echo_index;
1752 usb_fill_bulk_urb(urb, dev->udev,
1753 usb_sndbulkpipe(dev->udev,
1754 dev->bulk_out->bEndpointAddress),
1756 kvaser_usb_write_bulk_callback, context);
1757 usb_anchor_urb(urb, &priv->tx_submitted);
1759 err = usb_submit_urb(urb, GFP_ATOMIC);
1760 if (unlikely(err)) {
1761 spin_lock_irqsave(&priv->tx_contexts_lock, flags);
1763 can_free_echo_skb(netdev, context->echo_index);
1764 context->echo_index = dev->max_tx_urbs;
1765 --priv->active_tx_contexts;
1766 netif_wake_queue(netdev);
1768 spin_unlock_irqrestore(&priv->tx_contexts_lock, flags);
1770 usb_unanchor_urb(urb);
1772 stats->tx_dropped++;
1775 netif_device_detach(netdev);
1777 netdev_warn(netdev, "Failed tx_urb %d\n", err);
1789 static const struct net_device_ops kvaser_usb_netdev_ops = {
1790 .ndo_open = kvaser_usb_open,
1791 .ndo_stop = kvaser_usb_close,
1792 .ndo_start_xmit = kvaser_usb_start_xmit,
1793 .ndo_change_mtu = can_change_mtu,
1796 static const struct can_bittiming_const kvaser_usb_bittiming_const = {
1797 .name = "kvaser_usb",
1798 .tseg1_min = KVASER_USB_TSEG1_MIN,
1799 .tseg1_max = KVASER_USB_TSEG1_MAX,
1800 .tseg2_min = KVASER_USB_TSEG2_MIN,
1801 .tseg2_max = KVASER_USB_TSEG2_MAX,
1802 .sjw_max = KVASER_USB_SJW_MAX,
1803 .brp_min = KVASER_USB_BRP_MIN,
1804 .brp_max = KVASER_USB_BRP_MAX,
1805 .brp_inc = KVASER_USB_BRP_INC,
1808 static int kvaser_usb_set_bittiming(struct net_device *netdev)
1810 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1811 struct can_bittiming *bt = &priv->can.bittiming;
1812 struct kvaser_usb *dev = priv->dev;
1813 struct kvaser_msg *msg;
1816 msg = kmalloc(sizeof(*msg), GFP_KERNEL);
1820 msg->id = CMD_SET_BUS_PARAMS;
1821 msg->len = MSG_HEADER_LEN + sizeof(struct kvaser_msg_busparams);
1822 msg->u.busparams.channel = priv->channel;
1823 msg->u.busparams.tid = 0xff;
1824 msg->u.busparams.bitrate = cpu_to_le32(bt->bitrate);
1825 msg->u.busparams.sjw = bt->sjw;
1826 msg->u.busparams.tseg1 = bt->prop_seg + bt->phase_seg1;
1827 msg->u.busparams.tseg2 = bt->phase_seg2;
1829 if (priv->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES)
1830 msg->u.busparams.no_samp = 3;
1832 msg->u.busparams.no_samp = 1;
1834 rc = kvaser_usb_send_msg(dev, msg);
1840 static int kvaser_usb_set_mode(struct net_device *netdev,
1843 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1847 case CAN_MODE_START:
1848 err = kvaser_usb_simple_msg_async(priv, CMD_START_CHIP);
1859 static int kvaser_usb_get_berr_counter(const struct net_device *netdev,
1860 struct can_berr_counter *bec)
1862 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1869 static void kvaser_usb_remove_interfaces(struct kvaser_usb *dev)
1873 for (i = 0; i < dev->nchannels; i++) {
1877 unregister_candev(dev->nets[i]->netdev);
1880 kvaser_usb_unlink_all_urbs(dev);
1882 for (i = 0; i < dev->nchannels; i++) {
1886 free_candev(dev->nets[i]->netdev);
1890 static int kvaser_usb_init_one(struct usb_interface *intf,
1891 const struct usb_device_id *id, int channel)
1893 struct kvaser_usb *dev = usb_get_intfdata(intf);
1894 struct net_device *netdev;
1895 struct kvaser_usb_net_priv *priv;
1898 err = kvaser_usb_send_simple_msg(dev, CMD_RESET_CHIP, channel);
1902 netdev = alloc_candev(sizeof(*priv) +
1903 dev->max_tx_urbs * sizeof(*priv->tx_contexts),
1906 dev_err(&intf->dev, "Cannot alloc candev\n");
1910 priv = netdev_priv(netdev);
1912 init_usb_anchor(&priv->tx_submitted);
1913 init_completion(&priv->start_comp);
1914 init_completion(&priv->stop_comp);
1917 priv->netdev = netdev;
1918 priv->channel = channel;
1920 spin_lock_init(&priv->tx_contexts_lock);
1921 kvaser_usb_reset_tx_urb_contexts(priv);
1923 priv->can.state = CAN_STATE_STOPPED;
1924 priv->can.clock.freq = CAN_USB_CLOCK;
1925 priv->can.bittiming_const = &kvaser_usb_bittiming_const;
1926 priv->can.do_set_bittiming = kvaser_usb_set_bittiming;
1927 priv->can.do_set_mode = kvaser_usb_set_mode;
1928 if (id->driver_info & KVASER_HAS_TXRX_ERRORS)
1929 priv->can.do_get_berr_counter = kvaser_usb_get_berr_counter;
1930 priv->can.ctrlmode_supported = CAN_CTRLMODE_3_SAMPLES;
1931 if (id->driver_info & KVASER_HAS_SILENT_MODE)
1932 priv->can.ctrlmode_supported |= CAN_CTRLMODE_LISTENONLY;
1934 netdev->flags |= IFF_ECHO;
1936 netdev->netdev_ops = &kvaser_usb_netdev_ops;
1938 SET_NETDEV_DEV(netdev, &intf->dev);
1939 netdev->dev_id = channel;
1941 dev->nets[channel] = priv;
1943 err = register_candev(netdev);
1945 dev_err(&intf->dev, "Failed to register can device\n");
1946 free_candev(netdev);
1947 dev->nets[channel] = NULL;
1951 netdev_dbg(netdev, "device registered\n");
1956 static int kvaser_usb_get_endpoints(const struct usb_interface *intf,
1957 struct usb_endpoint_descriptor **in,
1958 struct usb_endpoint_descriptor **out)
1960 const struct usb_host_interface *iface_desc;
1961 struct usb_endpoint_descriptor *endpoint;
1964 iface_desc = &intf->altsetting[0];
1966 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
1967 endpoint = &iface_desc->endpoint[i].desc;
1969 if (!*in && usb_endpoint_is_bulk_in(endpoint))
1972 if (!*out && usb_endpoint_is_bulk_out(endpoint))
1975 /* use first bulk endpoint for in and out */
1983 static int kvaser_usb_probe(struct usb_interface *intf,
1984 const struct usb_device_id *id)
1986 struct kvaser_usb *dev;
1990 dev = devm_kzalloc(&intf->dev, sizeof(*dev), GFP_KERNEL);
1994 if (kvaser_is_leaf(id)) {
1995 dev->family = KVASER_LEAF;
1996 } else if (kvaser_is_usbcan(id)) {
1997 dev->family = KVASER_USBCAN;
2000 "Product ID (%d) does not belong to any known Kvaser USB family",
2005 err = kvaser_usb_get_endpoints(intf, &dev->bulk_in, &dev->bulk_out);
2007 dev_err(&intf->dev, "Cannot get usb endpoint(s)");
2011 dev->udev = interface_to_usbdev(intf);
2013 init_usb_anchor(&dev->rx_submitted);
2015 usb_set_intfdata(intf, dev);
2017 /* On some x86 laptops, plugging a Kvaser device again after
2018 * an unplug makes the firmware always ignore the very first
2019 * command. For such a case, provide some room for retries
2020 * instead of completely exiting the driver.
2023 err = kvaser_usb_get_software_info(dev);
2024 } while (--retry && err == -ETIMEDOUT);
2028 "Cannot get software infos, error %d\n", err);
2032 dev_dbg(&intf->dev, "Firmware version: %d.%d.%d\n",
2033 ((dev->fw_version >> 24) & 0xff),
2034 ((dev->fw_version >> 16) & 0xff),
2035 (dev->fw_version & 0xffff));
2037 dev_dbg(&intf->dev, "Max outstanding tx = %d URBs\n", dev->max_tx_urbs);
2039 err = kvaser_usb_get_card_info(dev);
2042 "Cannot get card infos, error %d\n", err);
2046 for (i = 0; i < dev->nchannels; i++) {
2047 err = kvaser_usb_init_one(intf, id, i);
2049 kvaser_usb_remove_interfaces(dev);
2057 static void kvaser_usb_disconnect(struct usb_interface *intf)
2059 struct kvaser_usb *dev = usb_get_intfdata(intf);
2061 usb_set_intfdata(intf, NULL);
2066 kvaser_usb_remove_interfaces(dev);
2069 static struct usb_driver kvaser_usb_driver = {
2070 .name = "kvaser_usb",
2071 .probe = kvaser_usb_probe,
2072 .disconnect = kvaser_usb_disconnect,
2073 .id_table = kvaser_usb_table,
2076 module_usb_driver(kvaser_usb_driver);
2078 MODULE_AUTHOR("Olivier Sobrie <olivier@sobrie.be>");
2079 MODULE_DESCRIPTION("CAN driver for Kvaser CAN/USB devices");
2080 MODULE_LICENSE("GPL v2");