1 // SPDX-License-Identifier: GPL-2.0
2 /* Parts of this driver are based on the following:
3 * - Kvaser linux leaf driver (version 4.78)
4 * - CAN driver for esd CAN-USB/2
5 * - Kvaser linux usbcanII driver (version 5.3)
7 * Copyright (C) 2002-2018 KVASER AB, Sweden. All rights reserved.
8 * Copyright (C) 2010 Matthias Fuchs <matthias.fuchs@esd.eu>, esd gmbh
9 * Copyright (C) 2012 Olivier Sobrie <olivier@sobrie.be>
10 * Copyright (C) 2015 Valeo S.A.
13 #include <linux/completion.h>
14 #include <linux/device.h>
15 #include <linux/gfp.h>
16 #include <linux/jiffies.h>
17 #include <linux/kernel.h>
18 #include <linux/netdevice.h>
19 #include <linux/spinlock.h>
20 #include <linux/string.h>
21 #include <linux/types.h>
22 #include <linux/units.h>
23 #include <linux/usb.h>
25 #include <linux/can.h>
26 #include <linux/can/dev.h>
27 #include <linux/can/error.h>
28 #include <linux/can/netlink.h>
30 #include "kvaser_usb.h"
32 #define MAX_USBCAN_NET_DEVICES 2
34 /* Command header size */
35 #define CMD_HEADER_LEN 2
37 /* Kvaser CAN message flags */
38 #define MSG_FLAG_ERROR_FRAME BIT(0)
39 #define MSG_FLAG_OVERRUN BIT(1)
40 #define MSG_FLAG_NERR BIT(2)
41 #define MSG_FLAG_WAKEUP BIT(3)
42 #define MSG_FLAG_REMOTE_FRAME BIT(4)
43 #define MSG_FLAG_RESERVED BIT(5)
44 #define MSG_FLAG_TX_ACK BIT(6)
45 #define MSG_FLAG_TX_REQUEST BIT(7)
47 /* CAN states (M16C CxSTRH register) */
48 #define M16C_STATE_BUS_RESET BIT(0)
49 #define M16C_STATE_BUS_ERROR BIT(4)
50 #define M16C_STATE_BUS_PASSIVE BIT(5)
51 #define M16C_STATE_BUS_OFF BIT(6)
53 /* Leaf/usbcan command ids */
54 #define CMD_RX_STD_MESSAGE 12
55 #define CMD_TX_STD_MESSAGE 13
56 #define CMD_RX_EXT_MESSAGE 14
57 #define CMD_TX_EXT_MESSAGE 15
58 #define CMD_SET_BUS_PARAMS 16
59 #define CMD_CHIP_STATE_EVENT 20
60 #define CMD_SET_CTRL_MODE 21
61 #define CMD_RESET_CHIP 24
62 #define CMD_START_CHIP 26
63 #define CMD_START_CHIP_REPLY 27
64 #define CMD_STOP_CHIP 28
65 #define CMD_STOP_CHIP_REPLY 29
67 #define CMD_USBCAN_CLOCK_OVERFLOW_EVENT 33
69 #define CMD_GET_CARD_INFO 34
70 #define CMD_GET_CARD_INFO_REPLY 35
71 #define CMD_GET_SOFTWARE_INFO 38
72 #define CMD_GET_SOFTWARE_INFO_REPLY 39
73 #define CMD_FLUSH_QUEUE 48
74 #define CMD_TX_ACKNOWLEDGE 50
75 #define CMD_CAN_ERROR_EVENT 51
76 #define CMD_FLUSH_QUEUE_REPLY 68
78 #define CMD_LEAF_LOG_MESSAGE 106
80 /* Leaf frequency options */
81 #define KVASER_USB_LEAF_SWOPTION_FREQ_MASK 0x60
82 #define KVASER_USB_LEAF_SWOPTION_FREQ_16_MHZ_CLK 0
83 #define KVASER_USB_LEAF_SWOPTION_FREQ_32_MHZ_CLK BIT(5)
84 #define KVASER_USB_LEAF_SWOPTION_FREQ_24_MHZ_CLK BIT(6)
87 #define M16C_EF_ACKE BIT(0)
88 #define M16C_EF_CRCE BIT(1)
89 #define M16C_EF_FORME BIT(2)
90 #define M16C_EF_STFE BIT(3)
91 #define M16C_EF_BITE0 BIT(4)
92 #define M16C_EF_BITE1 BIT(5)
93 #define M16C_EF_RCVE BIT(6)
94 #define M16C_EF_TRE BIT(7)
96 /* Only Leaf-based devices can report M16C error factors,
97 * thus define our own error status flags for USBCANII
99 #define USBCAN_ERROR_STATE_NONE 0
100 #define USBCAN_ERROR_STATE_TX_ERROR BIT(0)
101 #define USBCAN_ERROR_STATE_RX_ERROR BIT(1)
102 #define USBCAN_ERROR_STATE_BUSERROR BIT(2)
104 /* bittiming parameters */
105 #define KVASER_USB_TSEG1_MIN 1
106 #define KVASER_USB_TSEG1_MAX 16
107 #define KVASER_USB_TSEG2_MIN 1
108 #define KVASER_USB_TSEG2_MAX 8
109 #define KVASER_USB_SJW_MAX 4
110 #define KVASER_USB_BRP_MIN 1
111 #define KVASER_USB_BRP_MAX 64
112 #define KVASER_USB_BRP_INC 1
115 #define KVASER_CTRL_MODE_NORMAL 1
116 #define KVASER_CTRL_MODE_SILENT 2
117 #define KVASER_CTRL_MODE_SELFRECEPTION 3
118 #define KVASER_CTRL_MODE_OFF 4
120 /* Extended CAN identifier flag */
121 #define KVASER_EXTENDED_FRAME BIT(31)
123 struct kvaser_cmd_simple {
128 struct kvaser_cmd_cardinfo {
131 __le32 serial_number;
133 __le32 clock_resolution;
148 struct leaf_cmd_softinfo {
153 __le16 max_outstanding_tx;
157 struct usbcan_cmd_softinfo {
160 __le16 max_outstanding_tx;
167 struct kvaser_cmd_busparams {
177 struct kvaser_cmd_tx_can {
193 struct kvaser_cmd_rx_can_header {
198 struct leaf_cmd_rx_can {
206 struct usbcan_cmd_rx_can {
214 struct leaf_cmd_chip_state_event {
226 struct usbcan_cmd_chip_state_event {
238 struct kvaser_cmd_tx_acknowledge_header {
243 struct leaf_cmd_error_event {
255 struct usbcan_cmd_error_event {
258 u8 tx_errors_count_ch0;
259 u8 rx_errors_count_ch0;
260 u8 tx_errors_count_ch1;
261 u8 rx_errors_count_ch1;
267 struct kvaser_cmd_ctrl_mode {
274 struct kvaser_cmd_flush_queue {
281 struct leaf_cmd_log_message {
295 struct kvaser_cmd_simple simple;
296 struct kvaser_cmd_cardinfo cardinfo;
297 struct kvaser_cmd_busparams busparams;
299 struct kvaser_cmd_rx_can_header rx_can_header;
300 struct kvaser_cmd_tx_acknowledge_header tx_acknowledge_header;
303 struct leaf_cmd_softinfo softinfo;
304 struct leaf_cmd_rx_can rx_can;
305 struct leaf_cmd_chip_state_event chip_state_event;
306 struct leaf_cmd_error_event error_event;
307 struct leaf_cmd_log_message log_message;
311 struct usbcan_cmd_softinfo softinfo;
312 struct usbcan_cmd_rx_can rx_can;
313 struct usbcan_cmd_chip_state_event chip_state_event;
314 struct usbcan_cmd_error_event error_event;
317 struct kvaser_cmd_tx_can tx_can;
318 struct kvaser_cmd_ctrl_mode ctrl_mode;
319 struct kvaser_cmd_flush_queue flush_queue;
323 /* Summary of a kvaser error event, for a unified Leaf/Usbcan error
324 * handling. Some discrepancies between the two families exist:
326 * - USBCAN firmware does not report M16C "error factors"
327 * - USBCAN controllers has difficulties reporting if the raised error
328 * event is for ch0 or ch1. They leave such arbitration to the OS
329 * driver by letting it compare error counters with previous values
330 * and decide the error event's channel. Thus for USBCAN, the channel
331 * field is only advisory.
333 struct kvaser_usb_err_summary {
334 u8 channel, status, txerr, rxerr;
346 static const struct can_bittiming_const kvaser_usb_leaf_bittiming_const = {
347 .name = "kvaser_usb",
348 .tseg1_min = KVASER_USB_TSEG1_MIN,
349 .tseg1_max = KVASER_USB_TSEG1_MAX,
350 .tseg2_min = KVASER_USB_TSEG2_MIN,
351 .tseg2_max = KVASER_USB_TSEG2_MAX,
352 .sjw_max = KVASER_USB_SJW_MAX,
353 .brp_min = KVASER_USB_BRP_MIN,
354 .brp_max = KVASER_USB_BRP_MAX,
355 .brp_inc = KVASER_USB_BRP_INC,
358 static const struct kvaser_usb_dev_cfg kvaser_usb_leaf_dev_cfg_8mhz = {
360 .freq = 8 * MEGA /* Hz */,
363 .bittiming_const = &kvaser_usb_leaf_bittiming_const,
366 static const struct kvaser_usb_dev_cfg kvaser_usb_leaf_dev_cfg_16mhz = {
368 .freq = 16 * MEGA /* Hz */,
371 .bittiming_const = &kvaser_usb_leaf_bittiming_const,
374 static const struct kvaser_usb_dev_cfg kvaser_usb_leaf_dev_cfg_24mhz = {
376 .freq = 24 * MEGA /* Hz */,
379 .bittiming_const = &kvaser_usb_leaf_bittiming_const,
382 static const struct kvaser_usb_dev_cfg kvaser_usb_leaf_dev_cfg_32mhz = {
384 .freq = 32 * MEGA /* Hz */,
387 .bittiming_const = &kvaser_usb_leaf_bittiming_const,
391 kvaser_usb_leaf_frame_to_cmd(const struct kvaser_usb_net_priv *priv,
392 const struct sk_buff *skb, int *cmd_len,
395 struct kvaser_usb *dev = priv->dev;
396 struct kvaser_cmd *cmd;
397 u8 *cmd_tx_can_flags = NULL; /* GCC */
398 struct can_frame *cf = (struct can_frame *)skb->data;
400 cmd = kmalloc(sizeof(*cmd), GFP_ATOMIC);
402 cmd->u.tx_can.tid = transid & 0xff;
403 cmd->len = *cmd_len = CMD_HEADER_LEN +
404 sizeof(struct kvaser_cmd_tx_can);
405 cmd->u.tx_can.channel = priv->channel;
407 switch (dev->card_data.leaf.family) {
409 cmd_tx_can_flags = &cmd->u.tx_can.leaf.flags;
412 cmd_tx_can_flags = &cmd->u.tx_can.usbcan.flags;
416 *cmd_tx_can_flags = 0;
418 if (cf->can_id & CAN_EFF_FLAG) {
419 cmd->id = CMD_TX_EXT_MESSAGE;
420 cmd->u.tx_can.data[0] = (cf->can_id >> 24) & 0x1f;
421 cmd->u.tx_can.data[1] = (cf->can_id >> 18) & 0x3f;
422 cmd->u.tx_can.data[2] = (cf->can_id >> 14) & 0x0f;
423 cmd->u.tx_can.data[3] = (cf->can_id >> 6) & 0xff;
424 cmd->u.tx_can.data[4] = cf->can_id & 0x3f;
426 cmd->id = CMD_TX_STD_MESSAGE;
427 cmd->u.tx_can.data[0] = (cf->can_id >> 6) & 0x1f;
428 cmd->u.tx_can.data[1] = cf->can_id & 0x3f;
431 cmd->u.tx_can.data[5] = cf->len;
432 memcpy(&cmd->u.tx_can.data[6], cf->data, cf->len);
434 if (cf->can_id & CAN_RTR_FLAG)
435 *cmd_tx_can_flags |= MSG_FLAG_REMOTE_FRAME;
440 static int kvaser_usb_leaf_wait_cmd(const struct kvaser_usb *dev, u8 id,
441 struct kvaser_cmd *cmd)
443 struct kvaser_cmd *tmp;
448 unsigned long to = jiffies + msecs_to_jiffies(KVASER_USB_TIMEOUT);
450 buf = kzalloc(KVASER_USB_RX_BUFFER_SIZE, GFP_KERNEL);
455 err = kvaser_usb_recv_cmd(dev, buf, KVASER_USB_RX_BUFFER_SIZE,
461 while (pos <= actual_len - CMD_HEADER_LEN) {
464 /* Handle commands crossing the USB endpoint max packet
465 * size boundary. Check kvaser_usb_read_bulk_callback()
466 * for further details.
471 (dev->bulk_in->wMaxPacketSize));
475 if (pos + tmp->len > actual_len) {
476 dev_err_ratelimited(&dev->intf->dev,
482 memcpy(cmd, tmp, tmp->len);
488 } while (time_before(jiffies, to));
498 static int kvaser_usb_leaf_send_simple_cmd(const struct kvaser_usb *dev,
499 u8 cmd_id, int channel)
501 struct kvaser_cmd *cmd;
504 cmd = kmalloc(sizeof(*cmd), GFP_KERNEL);
509 cmd->len = CMD_HEADER_LEN + sizeof(struct kvaser_cmd_simple);
510 cmd->u.simple.channel = channel;
511 cmd->u.simple.tid = 0xff;
513 rc = kvaser_usb_send_cmd(dev, cmd, cmd->len);
519 static void kvaser_usb_leaf_get_software_info_leaf(struct kvaser_usb *dev,
520 const struct leaf_cmd_softinfo *softinfo)
522 u32 sw_options = le32_to_cpu(softinfo->sw_options);
524 dev->fw_version = le32_to_cpu(softinfo->fw_version);
525 dev->max_tx_urbs = le16_to_cpu(softinfo->max_outstanding_tx);
527 switch (sw_options & KVASER_USB_LEAF_SWOPTION_FREQ_MASK) {
528 case KVASER_USB_LEAF_SWOPTION_FREQ_16_MHZ_CLK:
529 dev->cfg = &kvaser_usb_leaf_dev_cfg_16mhz;
531 case KVASER_USB_LEAF_SWOPTION_FREQ_24_MHZ_CLK:
532 dev->cfg = &kvaser_usb_leaf_dev_cfg_24mhz;
534 case KVASER_USB_LEAF_SWOPTION_FREQ_32_MHZ_CLK:
535 dev->cfg = &kvaser_usb_leaf_dev_cfg_32mhz;
540 static int kvaser_usb_leaf_get_software_info_inner(struct kvaser_usb *dev)
542 struct kvaser_cmd cmd;
545 err = kvaser_usb_leaf_send_simple_cmd(dev, CMD_GET_SOFTWARE_INFO, 0);
549 err = kvaser_usb_leaf_wait_cmd(dev, CMD_GET_SOFTWARE_INFO_REPLY, &cmd);
553 switch (dev->card_data.leaf.family) {
555 kvaser_usb_leaf_get_software_info_leaf(dev, &cmd.u.leaf.softinfo);
558 dev->fw_version = le32_to_cpu(cmd.u.usbcan.softinfo.fw_version);
560 le16_to_cpu(cmd.u.usbcan.softinfo.max_outstanding_tx);
561 dev->cfg = &kvaser_usb_leaf_dev_cfg_8mhz;
568 static int kvaser_usb_leaf_get_software_info(struct kvaser_usb *dev)
573 /* On some x86 laptops, plugging a Kvaser device again after
574 * an unplug makes the firmware always ignore the very first
575 * command. For such a case, provide some room for retries
576 * instead of completely exiting the driver.
579 err = kvaser_usb_leaf_get_software_info_inner(dev);
580 } while (--retry && err == -ETIMEDOUT);
585 static int kvaser_usb_leaf_get_card_info(struct kvaser_usb *dev)
587 struct kvaser_cmd cmd;
590 err = kvaser_usb_leaf_send_simple_cmd(dev, CMD_GET_CARD_INFO, 0);
594 err = kvaser_usb_leaf_wait_cmd(dev, CMD_GET_CARD_INFO_REPLY, &cmd);
598 dev->nchannels = cmd.u.cardinfo.nchannels;
599 if (dev->nchannels > KVASER_USB_MAX_NET_DEVICES ||
600 (dev->card_data.leaf.family == KVASER_USBCAN &&
601 dev->nchannels > MAX_USBCAN_NET_DEVICES))
607 static void kvaser_usb_leaf_tx_acknowledge(const struct kvaser_usb *dev,
608 const struct kvaser_cmd *cmd)
610 struct net_device_stats *stats;
611 struct kvaser_usb_tx_urb_context *context;
612 struct kvaser_usb_net_priv *priv;
616 channel = cmd->u.tx_acknowledge_header.channel;
617 tid = cmd->u.tx_acknowledge_header.tid;
619 if (channel >= dev->nchannels) {
620 dev_err(&dev->intf->dev,
621 "Invalid channel number (%d)\n", channel);
625 priv = dev->nets[channel];
627 if (!netif_device_present(priv->netdev))
630 stats = &priv->netdev->stats;
632 context = &priv->tx_contexts[tid % dev->max_tx_urbs];
634 /* Sometimes the state change doesn't come after a bus-off event */
635 if (priv->can.restart_ms && priv->can.state >= CAN_STATE_BUS_OFF) {
637 struct can_frame *cf;
639 skb = alloc_can_err_skb(priv->netdev, &cf);
641 cf->can_id |= CAN_ERR_RESTARTED;
645 netdev_err(priv->netdev,
646 "No memory left for err_skb\n");
649 priv->can.can_stats.restarts++;
650 netif_carrier_on(priv->netdev);
652 priv->can.state = CAN_STATE_ERROR_ACTIVE;
655 spin_lock_irqsave(&priv->tx_contexts_lock, flags);
658 stats->tx_bytes += can_get_echo_skb(priv->netdev,
659 context->echo_index, NULL);
660 context->echo_index = dev->max_tx_urbs;
661 --priv->active_tx_contexts;
662 netif_wake_queue(priv->netdev);
664 spin_unlock_irqrestore(&priv->tx_contexts_lock, flags);
667 static int kvaser_usb_leaf_simple_cmd_async(struct kvaser_usb_net_priv *priv,
670 struct kvaser_cmd *cmd;
673 cmd = kzalloc(sizeof(*cmd), GFP_ATOMIC);
677 cmd->len = CMD_HEADER_LEN + sizeof(struct kvaser_cmd_simple);
679 cmd->u.simple.channel = priv->channel;
681 err = kvaser_usb_send_cmd_async(priv, cmd, cmd->len);
689 kvaser_usb_leaf_rx_error_update_can_state(struct kvaser_usb_net_priv *priv,
690 const struct kvaser_usb_err_summary *es,
691 struct can_frame *cf)
693 struct kvaser_usb *dev = priv->dev;
694 struct net_device_stats *stats = &priv->netdev->stats;
695 enum can_state cur_state, new_state, tx_state, rx_state;
697 netdev_dbg(priv->netdev, "Error status: 0x%02x\n", es->status);
699 new_state = priv->can.state;
700 cur_state = priv->can.state;
702 if (es->status & (M16C_STATE_BUS_OFF | M16C_STATE_BUS_RESET)) {
703 new_state = CAN_STATE_BUS_OFF;
704 } else if (es->status & M16C_STATE_BUS_PASSIVE) {
705 new_state = CAN_STATE_ERROR_PASSIVE;
706 } else if (es->status & M16C_STATE_BUS_ERROR) {
707 /* Guard against spurious error events after a busoff */
708 if (cur_state < CAN_STATE_BUS_OFF) {
709 if (es->txerr >= 128 || es->rxerr >= 128)
710 new_state = CAN_STATE_ERROR_PASSIVE;
711 else if (es->txerr >= 96 || es->rxerr >= 96)
712 new_state = CAN_STATE_ERROR_WARNING;
713 else if (cur_state > CAN_STATE_ERROR_ACTIVE)
714 new_state = CAN_STATE_ERROR_ACTIVE;
719 new_state = CAN_STATE_ERROR_ACTIVE;
721 if (new_state != cur_state) {
722 tx_state = (es->txerr >= es->rxerr) ? new_state : 0;
723 rx_state = (es->txerr <= es->rxerr) ? new_state : 0;
725 can_change_state(priv->netdev, cf, tx_state, rx_state);
728 if (priv->can.restart_ms &&
729 cur_state >= CAN_STATE_BUS_OFF &&
730 new_state < CAN_STATE_BUS_OFF)
731 priv->can.can_stats.restarts++;
733 switch (dev->card_data.leaf.family) {
735 if (es->leaf.error_factor) {
736 priv->can.can_stats.bus_error++;
741 if (es->usbcan.error_state & USBCAN_ERROR_STATE_TX_ERROR)
743 if (es->usbcan.error_state & USBCAN_ERROR_STATE_RX_ERROR)
745 if (es->usbcan.error_state & USBCAN_ERROR_STATE_BUSERROR)
746 priv->can.can_stats.bus_error++;
750 priv->bec.txerr = es->txerr;
751 priv->bec.rxerr = es->rxerr;
754 static void kvaser_usb_leaf_rx_error(const struct kvaser_usb *dev,
755 const struct kvaser_usb_err_summary *es)
757 struct can_frame *cf;
758 struct can_frame tmp_cf = { .can_id = CAN_ERR_FLAG,
759 .len = CAN_ERR_DLC };
761 struct net_device_stats *stats;
762 struct kvaser_usb_net_priv *priv;
763 enum can_state old_state, new_state;
765 if (es->channel >= dev->nchannels) {
766 dev_err(&dev->intf->dev,
767 "Invalid channel number (%d)\n", es->channel);
771 priv = dev->nets[es->channel];
772 stats = &priv->netdev->stats;
774 /* Update all of the CAN interface's state and error counters before
775 * trying any memory allocation that can actually fail with -ENOMEM.
777 * We send a temporary stack-allocated error CAN frame to
778 * can_change_state() for the very same reason.
780 * TODO: Split can_change_state() responsibility between updating the
781 * CAN interface's state and counters, and the setting up of CAN error
782 * frame ID and data to userspace. Remove stack allocation afterwards.
784 old_state = priv->can.state;
785 kvaser_usb_leaf_rx_error_update_can_state(priv, es, &tmp_cf);
786 new_state = priv->can.state;
788 skb = alloc_can_err_skb(priv->netdev, &cf);
793 memcpy(cf, &tmp_cf, sizeof(*cf));
795 if (new_state != old_state) {
797 (M16C_STATE_BUS_OFF | M16C_STATE_BUS_RESET)) {
798 if (!priv->can.restart_ms)
799 kvaser_usb_leaf_simple_cmd_async(priv,
801 netif_carrier_off(priv->netdev);
804 if (priv->can.restart_ms &&
805 old_state >= CAN_STATE_BUS_OFF &&
806 new_state < CAN_STATE_BUS_OFF) {
807 cf->can_id |= CAN_ERR_RESTARTED;
808 netif_carrier_on(priv->netdev);
812 switch (dev->card_data.leaf.family) {
814 if (es->leaf.error_factor) {
815 cf->can_id |= CAN_ERR_BUSERROR | CAN_ERR_PROT;
817 if (es->leaf.error_factor & M16C_EF_ACKE)
818 cf->data[3] = CAN_ERR_PROT_LOC_ACK;
819 if (es->leaf.error_factor & M16C_EF_CRCE)
820 cf->data[3] = CAN_ERR_PROT_LOC_CRC_SEQ;
821 if (es->leaf.error_factor & M16C_EF_FORME)
822 cf->data[2] |= CAN_ERR_PROT_FORM;
823 if (es->leaf.error_factor & M16C_EF_STFE)
824 cf->data[2] |= CAN_ERR_PROT_STUFF;
825 if (es->leaf.error_factor & M16C_EF_BITE0)
826 cf->data[2] |= CAN_ERR_PROT_BIT0;
827 if (es->leaf.error_factor & M16C_EF_BITE1)
828 cf->data[2] |= CAN_ERR_PROT_BIT1;
829 if (es->leaf.error_factor & M16C_EF_TRE)
830 cf->data[2] |= CAN_ERR_PROT_TX;
834 if (es->usbcan.error_state & USBCAN_ERROR_STATE_BUSERROR)
835 cf->can_id |= CAN_ERR_BUSERROR;
839 cf->data[6] = es->txerr;
840 cf->data[7] = es->rxerr;
845 /* For USBCAN, report error to userspace if the channels's errors counter
846 * has changed, or we're the only channel seeing a bus error state.
849 kvaser_usb_leaf_usbcan_conditionally_rx_error(const struct kvaser_usb *dev,
850 struct kvaser_usb_err_summary *es)
852 struct kvaser_usb_net_priv *priv;
853 unsigned int channel;
856 channel = es->channel;
857 if (channel >= dev->nchannels) {
858 dev_err(&dev->intf->dev,
859 "Invalid channel number (%d)\n", channel);
863 priv = dev->nets[channel];
864 report_error = false;
866 if (es->txerr != priv->bec.txerr) {
867 es->usbcan.error_state |= USBCAN_ERROR_STATE_TX_ERROR;
870 if (es->rxerr != priv->bec.rxerr) {
871 es->usbcan.error_state |= USBCAN_ERROR_STATE_RX_ERROR;
874 if ((es->status & M16C_STATE_BUS_ERROR) &&
875 !(es->usbcan.other_ch_status & M16C_STATE_BUS_ERROR)) {
876 es->usbcan.error_state |= USBCAN_ERROR_STATE_BUSERROR;
881 kvaser_usb_leaf_rx_error(dev, es);
884 static void kvaser_usb_leaf_usbcan_rx_error(const struct kvaser_usb *dev,
885 const struct kvaser_cmd *cmd)
887 struct kvaser_usb_err_summary es = { };
890 /* Sometimes errors are sent as unsolicited chip state events */
891 case CMD_CHIP_STATE_EVENT:
892 es.channel = cmd->u.usbcan.chip_state_event.channel;
893 es.status = cmd->u.usbcan.chip_state_event.status;
894 es.txerr = cmd->u.usbcan.chip_state_event.tx_errors_count;
895 es.rxerr = cmd->u.usbcan.chip_state_event.rx_errors_count;
896 kvaser_usb_leaf_usbcan_conditionally_rx_error(dev, &es);
899 case CMD_CAN_ERROR_EVENT:
901 es.status = cmd->u.usbcan.error_event.status_ch0;
902 es.txerr = cmd->u.usbcan.error_event.tx_errors_count_ch0;
903 es.rxerr = cmd->u.usbcan.error_event.rx_errors_count_ch0;
904 es.usbcan.other_ch_status =
905 cmd->u.usbcan.error_event.status_ch1;
906 kvaser_usb_leaf_usbcan_conditionally_rx_error(dev, &es);
908 /* The USBCAN firmware supports up to 2 channels.
909 * Now that ch0 was checked, check if ch1 has any errors.
911 if (dev->nchannels == MAX_USBCAN_NET_DEVICES) {
913 es.status = cmd->u.usbcan.error_event.status_ch1;
915 cmd->u.usbcan.error_event.tx_errors_count_ch1;
917 cmd->u.usbcan.error_event.rx_errors_count_ch1;
918 es.usbcan.other_ch_status =
919 cmd->u.usbcan.error_event.status_ch0;
920 kvaser_usb_leaf_usbcan_conditionally_rx_error(dev, &es);
925 dev_err(&dev->intf->dev, "Invalid cmd id (%d)\n", cmd->id);
929 static void kvaser_usb_leaf_leaf_rx_error(const struct kvaser_usb *dev,
930 const struct kvaser_cmd *cmd)
932 struct kvaser_usb_err_summary es = { };
935 case CMD_CAN_ERROR_EVENT:
936 es.channel = cmd->u.leaf.error_event.channel;
937 es.status = cmd->u.leaf.error_event.status;
938 es.txerr = cmd->u.leaf.error_event.tx_errors_count;
939 es.rxerr = cmd->u.leaf.error_event.rx_errors_count;
940 es.leaf.error_factor = cmd->u.leaf.error_event.error_factor;
942 case CMD_LEAF_LOG_MESSAGE:
943 es.channel = cmd->u.leaf.log_message.channel;
944 es.status = cmd->u.leaf.log_message.data[0];
945 es.txerr = cmd->u.leaf.log_message.data[2];
946 es.rxerr = cmd->u.leaf.log_message.data[3];
947 es.leaf.error_factor = cmd->u.leaf.log_message.data[1];
949 case CMD_CHIP_STATE_EVENT:
950 es.channel = cmd->u.leaf.chip_state_event.channel;
951 es.status = cmd->u.leaf.chip_state_event.status;
952 es.txerr = cmd->u.leaf.chip_state_event.tx_errors_count;
953 es.rxerr = cmd->u.leaf.chip_state_event.rx_errors_count;
954 es.leaf.error_factor = 0;
957 dev_err(&dev->intf->dev, "Invalid cmd id (%d)\n", cmd->id);
961 kvaser_usb_leaf_rx_error(dev, &es);
964 static void kvaser_usb_leaf_rx_can_err(const struct kvaser_usb_net_priv *priv,
965 const struct kvaser_cmd *cmd)
967 if (cmd->u.rx_can_header.flag & (MSG_FLAG_ERROR_FRAME |
969 struct net_device_stats *stats = &priv->netdev->stats;
971 netdev_err(priv->netdev, "Unknown error (flags: 0x%02x)\n",
972 cmd->u.rx_can_header.flag);
978 if (cmd->u.rx_can_header.flag & MSG_FLAG_OVERRUN)
979 kvaser_usb_can_rx_over_error(priv->netdev);
982 static void kvaser_usb_leaf_rx_can_msg(const struct kvaser_usb *dev,
983 const struct kvaser_cmd *cmd)
985 struct kvaser_usb_net_priv *priv;
986 struct can_frame *cf;
988 struct net_device_stats *stats;
989 u8 channel = cmd->u.rx_can_header.channel;
990 const u8 *rx_data = NULL; /* GCC */
992 if (channel >= dev->nchannels) {
993 dev_err(&dev->intf->dev,
994 "Invalid channel number (%d)\n", channel);
998 priv = dev->nets[channel];
999 stats = &priv->netdev->stats;
1001 if ((cmd->u.rx_can_header.flag & MSG_FLAG_ERROR_FRAME) &&
1002 (dev->card_data.leaf.family == KVASER_LEAF &&
1003 cmd->id == CMD_LEAF_LOG_MESSAGE)) {
1004 kvaser_usb_leaf_leaf_rx_error(dev, cmd);
1006 } else if (cmd->u.rx_can_header.flag & (MSG_FLAG_ERROR_FRAME |
1008 MSG_FLAG_OVERRUN)) {
1009 kvaser_usb_leaf_rx_can_err(priv, cmd);
1011 } else if (cmd->u.rx_can_header.flag & ~MSG_FLAG_REMOTE_FRAME) {
1012 netdev_warn(priv->netdev,
1013 "Unhandled frame (flags: 0x%02x)\n",
1014 cmd->u.rx_can_header.flag);
1018 switch (dev->card_data.leaf.family) {
1020 rx_data = cmd->u.leaf.rx_can.data;
1023 rx_data = cmd->u.usbcan.rx_can.data;
1027 skb = alloc_can_skb(priv->netdev, &cf);
1029 stats->rx_dropped++;
1033 if (dev->card_data.leaf.family == KVASER_LEAF && cmd->id ==
1034 CMD_LEAF_LOG_MESSAGE) {
1035 cf->can_id = le32_to_cpu(cmd->u.leaf.log_message.id);
1036 if (cf->can_id & KVASER_EXTENDED_FRAME)
1037 cf->can_id &= CAN_EFF_MASK | CAN_EFF_FLAG;
1039 cf->can_id &= CAN_SFF_MASK;
1041 cf->len = can_cc_dlc2len(cmd->u.leaf.log_message.dlc);
1043 if (cmd->u.leaf.log_message.flags & MSG_FLAG_REMOTE_FRAME)
1044 cf->can_id |= CAN_RTR_FLAG;
1046 memcpy(cf->data, &cmd->u.leaf.log_message.data,
1049 cf->can_id = ((rx_data[0] & 0x1f) << 6) | (rx_data[1] & 0x3f);
1051 if (cmd->id == CMD_RX_EXT_MESSAGE) {
1053 cf->can_id |= ((rx_data[2] & 0x0f) << 14) |
1054 ((rx_data[3] & 0xff) << 6) |
1055 (rx_data[4] & 0x3f);
1056 cf->can_id |= CAN_EFF_FLAG;
1059 cf->len = can_cc_dlc2len(rx_data[5]);
1061 if (cmd->u.rx_can_header.flag & MSG_FLAG_REMOTE_FRAME)
1062 cf->can_id |= CAN_RTR_FLAG;
1064 memcpy(cf->data, &rx_data[6], cf->len);
1067 stats->rx_packets++;
1068 if (!(cf->can_id & CAN_RTR_FLAG))
1069 stats->rx_bytes += cf->len;
1073 static void kvaser_usb_leaf_start_chip_reply(const struct kvaser_usb *dev,
1074 const struct kvaser_cmd *cmd)
1076 struct kvaser_usb_net_priv *priv;
1077 u8 channel = cmd->u.simple.channel;
1079 if (channel >= dev->nchannels) {
1080 dev_err(&dev->intf->dev,
1081 "Invalid channel number (%d)\n", channel);
1085 priv = dev->nets[channel];
1087 if (completion_done(&priv->start_comp) &&
1088 netif_queue_stopped(priv->netdev)) {
1089 netif_wake_queue(priv->netdev);
1091 netif_start_queue(priv->netdev);
1092 complete(&priv->start_comp);
1096 static void kvaser_usb_leaf_stop_chip_reply(const struct kvaser_usb *dev,
1097 const struct kvaser_cmd *cmd)
1099 struct kvaser_usb_net_priv *priv;
1100 u8 channel = cmd->u.simple.channel;
1102 if (channel >= dev->nchannels) {
1103 dev_err(&dev->intf->dev,
1104 "Invalid channel number (%d)\n", channel);
1108 priv = dev->nets[channel];
1110 complete(&priv->stop_comp);
1113 static void kvaser_usb_leaf_handle_command(const struct kvaser_usb *dev,
1114 const struct kvaser_cmd *cmd)
1117 case CMD_START_CHIP_REPLY:
1118 kvaser_usb_leaf_start_chip_reply(dev, cmd);
1121 case CMD_STOP_CHIP_REPLY:
1122 kvaser_usb_leaf_stop_chip_reply(dev, cmd);
1125 case CMD_RX_STD_MESSAGE:
1126 case CMD_RX_EXT_MESSAGE:
1127 kvaser_usb_leaf_rx_can_msg(dev, cmd);
1130 case CMD_LEAF_LOG_MESSAGE:
1131 if (dev->card_data.leaf.family != KVASER_LEAF)
1133 kvaser_usb_leaf_rx_can_msg(dev, cmd);
1136 case CMD_CHIP_STATE_EVENT:
1137 case CMD_CAN_ERROR_EVENT:
1138 if (dev->card_data.leaf.family == KVASER_LEAF)
1139 kvaser_usb_leaf_leaf_rx_error(dev, cmd);
1141 kvaser_usb_leaf_usbcan_rx_error(dev, cmd);
1144 case CMD_TX_ACKNOWLEDGE:
1145 kvaser_usb_leaf_tx_acknowledge(dev, cmd);
1148 /* Ignored commands */
1149 case CMD_USBCAN_CLOCK_OVERFLOW_EVENT:
1150 if (dev->card_data.leaf.family != KVASER_USBCAN)
1154 case CMD_FLUSH_QUEUE_REPLY:
1155 if (dev->card_data.leaf.family != KVASER_LEAF)
1160 warn: dev_warn(&dev->intf->dev, "Unhandled command (%d)\n", cmd->id);
1165 static void kvaser_usb_leaf_read_bulk_callback(struct kvaser_usb *dev,
1168 struct kvaser_cmd *cmd;
1171 while (pos <= len - CMD_HEADER_LEN) {
1174 /* The Kvaser firmware can only read and write commands that
1175 * does not cross the USB's endpoint wMaxPacketSize boundary.
1176 * If a follow-up command crosses such boundary, firmware puts
1177 * a placeholder zero-length command in its place then aligns
1178 * the real command to the next max packet size.
1180 * Handle such cases or we're going to miss a significant
1181 * number of events in case of a heavy rx load on the bus.
1183 if (cmd->len == 0) {
1184 pos = round_up(pos, le16_to_cpu
1185 (dev->bulk_in->wMaxPacketSize));
1189 if (pos + cmd->len > len) {
1190 dev_err_ratelimited(&dev->intf->dev, "Format error\n");
1194 kvaser_usb_leaf_handle_command(dev, cmd);
1199 static int kvaser_usb_leaf_set_opt_mode(const struct kvaser_usb_net_priv *priv)
1201 struct kvaser_cmd *cmd;
1204 cmd = kzalloc(sizeof(*cmd), GFP_KERNEL);
1208 cmd->id = CMD_SET_CTRL_MODE;
1209 cmd->len = CMD_HEADER_LEN + sizeof(struct kvaser_cmd_ctrl_mode);
1210 cmd->u.ctrl_mode.tid = 0xff;
1211 cmd->u.ctrl_mode.channel = priv->channel;
1213 if (priv->can.ctrlmode & CAN_CTRLMODE_LISTENONLY)
1214 cmd->u.ctrl_mode.ctrl_mode = KVASER_CTRL_MODE_SILENT;
1216 cmd->u.ctrl_mode.ctrl_mode = KVASER_CTRL_MODE_NORMAL;
1218 rc = kvaser_usb_send_cmd(priv->dev, cmd, cmd->len);
1224 static int kvaser_usb_leaf_start_chip(struct kvaser_usb_net_priv *priv)
1228 init_completion(&priv->start_comp);
1230 err = kvaser_usb_leaf_send_simple_cmd(priv->dev, CMD_START_CHIP,
1235 if (!wait_for_completion_timeout(&priv->start_comp,
1236 msecs_to_jiffies(KVASER_USB_TIMEOUT)))
1242 static int kvaser_usb_leaf_stop_chip(struct kvaser_usb_net_priv *priv)
1246 init_completion(&priv->stop_comp);
1248 err = kvaser_usb_leaf_send_simple_cmd(priv->dev, CMD_STOP_CHIP,
1253 if (!wait_for_completion_timeout(&priv->stop_comp,
1254 msecs_to_jiffies(KVASER_USB_TIMEOUT)))
1260 static int kvaser_usb_leaf_reset_chip(struct kvaser_usb *dev, int channel)
1262 return kvaser_usb_leaf_send_simple_cmd(dev, CMD_RESET_CHIP, channel);
1265 static int kvaser_usb_leaf_flush_queue(struct kvaser_usb_net_priv *priv)
1267 struct kvaser_cmd *cmd;
1270 cmd = kzalloc(sizeof(*cmd), GFP_KERNEL);
1274 cmd->id = CMD_FLUSH_QUEUE;
1275 cmd->len = CMD_HEADER_LEN + sizeof(struct kvaser_cmd_flush_queue);
1276 cmd->u.flush_queue.channel = priv->channel;
1277 cmd->u.flush_queue.flags = 0x00;
1279 rc = kvaser_usb_send_cmd(priv->dev, cmd, cmd->len);
1285 static int kvaser_usb_leaf_init_card(struct kvaser_usb *dev)
1287 struct kvaser_usb_dev_card_data *card_data = &dev->card_data;
1289 card_data->ctrlmode_supported |= CAN_CTRLMODE_3_SAMPLES;
1294 static int kvaser_usb_leaf_set_bittiming(struct net_device *netdev)
1296 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1297 struct can_bittiming *bt = &priv->can.bittiming;
1298 struct kvaser_usb *dev = priv->dev;
1299 struct kvaser_cmd *cmd;
1302 cmd = kmalloc(sizeof(*cmd), GFP_KERNEL);
1306 cmd->id = CMD_SET_BUS_PARAMS;
1307 cmd->len = CMD_HEADER_LEN + sizeof(struct kvaser_cmd_busparams);
1308 cmd->u.busparams.channel = priv->channel;
1309 cmd->u.busparams.tid = 0xff;
1310 cmd->u.busparams.bitrate = cpu_to_le32(bt->bitrate);
1311 cmd->u.busparams.sjw = bt->sjw;
1312 cmd->u.busparams.tseg1 = bt->prop_seg + bt->phase_seg1;
1313 cmd->u.busparams.tseg2 = bt->phase_seg2;
1315 if (priv->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES)
1316 cmd->u.busparams.no_samp = 3;
1318 cmd->u.busparams.no_samp = 1;
1320 rc = kvaser_usb_send_cmd(dev, cmd, cmd->len);
1326 static int kvaser_usb_leaf_set_mode(struct net_device *netdev,
1329 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1333 case CAN_MODE_START:
1334 err = kvaser_usb_leaf_simple_cmd_async(priv, CMD_START_CHIP);
1345 static int kvaser_usb_leaf_get_berr_counter(const struct net_device *netdev,
1346 struct can_berr_counter *bec)
1348 struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1355 static int kvaser_usb_leaf_setup_endpoints(struct kvaser_usb *dev)
1357 const struct usb_host_interface *iface_desc;
1358 struct usb_endpoint_descriptor *endpoint;
1361 iface_desc = dev->intf->cur_altsetting;
1363 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
1364 endpoint = &iface_desc->endpoint[i].desc;
1366 if (!dev->bulk_in && usb_endpoint_is_bulk_in(endpoint))
1367 dev->bulk_in = endpoint;
1369 if (!dev->bulk_out && usb_endpoint_is_bulk_out(endpoint))
1370 dev->bulk_out = endpoint;
1372 /* use first bulk endpoint for in and out */
1373 if (dev->bulk_in && dev->bulk_out)
1380 const struct kvaser_usb_dev_ops kvaser_usb_leaf_dev_ops = {
1381 .dev_set_mode = kvaser_usb_leaf_set_mode,
1382 .dev_set_bittiming = kvaser_usb_leaf_set_bittiming,
1383 .dev_set_data_bittiming = NULL,
1384 .dev_get_berr_counter = kvaser_usb_leaf_get_berr_counter,
1385 .dev_setup_endpoints = kvaser_usb_leaf_setup_endpoints,
1386 .dev_init_card = kvaser_usb_leaf_init_card,
1387 .dev_get_software_info = kvaser_usb_leaf_get_software_info,
1388 .dev_get_software_details = NULL,
1389 .dev_get_card_info = kvaser_usb_leaf_get_card_info,
1390 .dev_get_capabilities = NULL,
1391 .dev_set_opt_mode = kvaser_usb_leaf_set_opt_mode,
1392 .dev_start_chip = kvaser_usb_leaf_start_chip,
1393 .dev_stop_chip = kvaser_usb_leaf_stop_chip,
1394 .dev_reset_chip = kvaser_usb_leaf_reset_chip,
1395 .dev_flush_queue = kvaser_usb_leaf_flush_queue,
1396 .dev_read_bulk_callback = kvaser_usb_leaf_read_bulk_callback,
1397 .dev_frame_to_cmd = kvaser_usb_leaf_frame_to_cmd,