xref: /OK3568_Linux_fs/kernel/drivers/net/can/usb/kvaser_usb/kvaser_usb_leaf.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
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)
6  *
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.
11  */
12 
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/usb.h>
23 
24 #include <linux/can.h>
25 #include <linux/can/dev.h>
26 #include <linux/can/error.h>
27 #include <linux/can/netlink.h>
28 
29 #include "kvaser_usb.h"
30 
31 #define MAX_USBCAN_NET_DEVICES		2
32 
33 /* Command header size */
34 #define CMD_HEADER_LEN			2
35 
36 /* Kvaser CAN message flags */
37 #define MSG_FLAG_ERROR_FRAME		BIT(0)
38 #define MSG_FLAG_OVERRUN		BIT(1)
39 #define MSG_FLAG_NERR			BIT(2)
40 #define MSG_FLAG_WAKEUP			BIT(3)
41 #define MSG_FLAG_REMOTE_FRAME		BIT(4)
42 #define MSG_FLAG_RESERVED		BIT(5)
43 #define MSG_FLAG_TX_ACK			BIT(6)
44 #define MSG_FLAG_TX_REQUEST		BIT(7)
45 
46 /* CAN states (M16C CxSTRH register) */
47 #define M16C_STATE_BUS_RESET		BIT(0)
48 #define M16C_STATE_BUS_ERROR		BIT(4)
49 #define M16C_STATE_BUS_PASSIVE		BIT(5)
50 #define M16C_STATE_BUS_OFF		BIT(6)
51 
52 /* Leaf/usbcan command ids */
53 #define CMD_RX_STD_MESSAGE		12
54 #define CMD_TX_STD_MESSAGE		13
55 #define CMD_RX_EXT_MESSAGE		14
56 #define CMD_TX_EXT_MESSAGE		15
57 #define CMD_SET_BUS_PARAMS		16
58 #define CMD_CHIP_STATE_EVENT		20
59 #define CMD_SET_CTRL_MODE		21
60 #define CMD_RESET_CHIP			24
61 #define CMD_START_CHIP			26
62 #define CMD_START_CHIP_REPLY		27
63 #define CMD_STOP_CHIP			28
64 #define CMD_STOP_CHIP_REPLY		29
65 
66 #define CMD_USBCAN_CLOCK_OVERFLOW_EVENT	33
67 
68 #define CMD_GET_CARD_INFO		34
69 #define CMD_GET_CARD_INFO_REPLY		35
70 #define CMD_GET_SOFTWARE_INFO		38
71 #define CMD_GET_SOFTWARE_INFO_REPLY	39
72 #define CMD_FLUSH_QUEUE			48
73 #define CMD_TX_ACKNOWLEDGE		50
74 #define CMD_CAN_ERROR_EVENT		51
75 #define CMD_FLUSH_QUEUE_REPLY		68
76 
77 #define CMD_LEAF_LOG_MESSAGE		106
78 
79 /* Leaf frequency options */
80 #define KVASER_USB_LEAF_SWOPTION_FREQ_MASK 0x60
81 #define KVASER_USB_LEAF_SWOPTION_FREQ_16_MHZ_CLK 0
82 #define KVASER_USB_LEAF_SWOPTION_FREQ_32_MHZ_CLK BIT(5)
83 #define KVASER_USB_LEAF_SWOPTION_FREQ_24_MHZ_CLK BIT(6)
84 
85 /* error factors */
86 #define M16C_EF_ACKE			BIT(0)
87 #define M16C_EF_CRCE			BIT(1)
88 #define M16C_EF_FORME			BIT(2)
89 #define M16C_EF_STFE			BIT(3)
90 #define M16C_EF_BITE0			BIT(4)
91 #define M16C_EF_BITE1			BIT(5)
92 #define M16C_EF_RCVE			BIT(6)
93 #define M16C_EF_TRE			BIT(7)
94 
95 /* Only Leaf-based devices can report M16C error factors,
96  * thus define our own error status flags for USBCANII
97  */
98 #define USBCAN_ERROR_STATE_NONE		0
99 #define USBCAN_ERROR_STATE_TX_ERROR	BIT(0)
100 #define USBCAN_ERROR_STATE_RX_ERROR	BIT(1)
101 #define USBCAN_ERROR_STATE_BUSERROR	BIT(2)
102 
103 /* ctrl modes */
104 #define KVASER_CTRL_MODE_NORMAL		1
105 #define KVASER_CTRL_MODE_SILENT		2
106 #define KVASER_CTRL_MODE_SELFRECEPTION	3
107 #define KVASER_CTRL_MODE_OFF		4
108 
109 /* Extended CAN identifier flag */
110 #define KVASER_EXTENDED_FRAME		BIT(31)
111 
112 struct kvaser_cmd_simple {
113 	u8 tid;
114 	u8 channel;
115 } __packed;
116 
117 struct kvaser_cmd_cardinfo {
118 	u8 tid;
119 	u8 nchannels;
120 	__le32 serial_number;
121 	__le32 padding0;
122 	__le32 clock_resolution;
123 	__le32 mfgdate;
124 	u8 ean[8];
125 	u8 hw_revision;
126 	union {
127 		struct {
128 			u8 usb_hs_mode;
129 		} __packed leaf1;
130 		struct {
131 			u8 padding;
132 		} __packed usbcan1;
133 	} __packed;
134 	__le16 padding1;
135 } __packed;
136 
137 struct leaf_cmd_softinfo {
138 	u8 tid;
139 	u8 padding0;
140 	__le32 sw_options;
141 	__le32 fw_version;
142 	__le16 max_outstanding_tx;
143 	__le16 padding1[9];
144 } __packed;
145 
146 struct usbcan_cmd_softinfo {
147 	u8 tid;
148 	u8 fw_name[5];
149 	__le16 max_outstanding_tx;
150 	u8 padding[6];
151 	__le32 fw_version;
152 	__le16 checksum;
153 	__le16 sw_options;
154 } __packed;
155 
156 struct kvaser_cmd_busparams {
157 	u8 tid;
158 	u8 channel;
159 	__le32 bitrate;
160 	u8 tseg1;
161 	u8 tseg2;
162 	u8 sjw;
163 	u8 no_samp;
164 } __packed;
165 
166 struct kvaser_cmd_tx_can {
167 	u8 channel;
168 	u8 tid;
169 	u8 data[14];
170 	union {
171 		struct {
172 			u8 padding;
173 			u8 flags;
174 		} __packed leaf;
175 		struct {
176 			u8 flags;
177 			u8 padding;
178 		} __packed usbcan;
179 	} __packed;
180 } __packed;
181 
182 struct kvaser_cmd_rx_can_header {
183 	u8 channel;
184 	u8 flag;
185 } __packed;
186 
187 struct leaf_cmd_rx_can {
188 	u8 channel;
189 	u8 flag;
190 
191 	__le16 time[3];
192 	u8 data[14];
193 } __packed;
194 
195 struct usbcan_cmd_rx_can {
196 	u8 channel;
197 	u8 flag;
198 
199 	u8 data[14];
200 	__le16 time;
201 } __packed;
202 
203 struct leaf_cmd_chip_state_event {
204 	u8 tid;
205 	u8 channel;
206 
207 	__le16 time[3];
208 	u8 tx_errors_count;
209 	u8 rx_errors_count;
210 
211 	u8 status;
212 	u8 padding[3];
213 } __packed;
214 
215 struct usbcan_cmd_chip_state_event {
216 	u8 tid;
217 	u8 channel;
218 
219 	u8 tx_errors_count;
220 	u8 rx_errors_count;
221 	__le16 time;
222 
223 	u8 status;
224 	u8 padding[3];
225 } __packed;
226 
227 struct kvaser_cmd_tx_acknowledge_header {
228 	u8 channel;
229 	u8 tid;
230 } __packed;
231 
232 struct leaf_cmd_error_event {
233 	u8 tid;
234 	u8 flags;
235 	__le16 time[3];
236 	u8 channel;
237 	u8 padding;
238 	u8 tx_errors_count;
239 	u8 rx_errors_count;
240 	u8 status;
241 	u8 error_factor;
242 } __packed;
243 
244 struct usbcan_cmd_error_event {
245 	u8 tid;
246 	u8 padding;
247 	u8 tx_errors_count_ch0;
248 	u8 rx_errors_count_ch0;
249 	u8 tx_errors_count_ch1;
250 	u8 rx_errors_count_ch1;
251 	u8 status_ch0;
252 	u8 status_ch1;
253 	__le16 time;
254 } __packed;
255 
256 struct kvaser_cmd_ctrl_mode {
257 	u8 tid;
258 	u8 channel;
259 	u8 ctrl_mode;
260 	u8 padding[3];
261 } __packed;
262 
263 struct kvaser_cmd_flush_queue {
264 	u8 tid;
265 	u8 channel;
266 	u8 flags;
267 	u8 padding[3];
268 } __packed;
269 
270 struct leaf_cmd_log_message {
271 	u8 channel;
272 	u8 flags;
273 	__le16 time[3];
274 	u8 dlc;
275 	u8 time_offset;
276 	__le32 id;
277 	u8 data[8];
278 } __packed;
279 
280 struct kvaser_cmd {
281 	u8 len;
282 	u8 id;
283 	union	{
284 		struct kvaser_cmd_simple simple;
285 		struct kvaser_cmd_cardinfo cardinfo;
286 		struct kvaser_cmd_busparams busparams;
287 
288 		struct kvaser_cmd_rx_can_header rx_can_header;
289 		struct kvaser_cmd_tx_acknowledge_header tx_acknowledge_header;
290 
291 		union {
292 			struct leaf_cmd_softinfo softinfo;
293 			struct leaf_cmd_rx_can rx_can;
294 			struct leaf_cmd_chip_state_event chip_state_event;
295 			struct leaf_cmd_error_event error_event;
296 			struct leaf_cmd_log_message log_message;
297 		} __packed leaf;
298 
299 		union {
300 			struct usbcan_cmd_softinfo softinfo;
301 			struct usbcan_cmd_rx_can rx_can;
302 			struct usbcan_cmd_chip_state_event chip_state_event;
303 			struct usbcan_cmd_error_event error_event;
304 		} __packed usbcan;
305 
306 		struct kvaser_cmd_tx_can tx_can;
307 		struct kvaser_cmd_ctrl_mode ctrl_mode;
308 		struct kvaser_cmd_flush_queue flush_queue;
309 	} u;
310 } __packed;
311 
312 #define CMD_SIZE_ANY 0xff
313 #define kvaser_fsize(field) sizeof_field(struct kvaser_cmd, field)
314 
315 static const u8 kvaser_usb_leaf_cmd_sizes_leaf[] = {
316 	[CMD_START_CHIP_REPLY]		= kvaser_fsize(u.simple),
317 	[CMD_STOP_CHIP_REPLY]		= kvaser_fsize(u.simple),
318 	[CMD_GET_CARD_INFO_REPLY]	= kvaser_fsize(u.cardinfo),
319 	[CMD_TX_ACKNOWLEDGE]		= kvaser_fsize(u.tx_acknowledge_header),
320 	[CMD_GET_SOFTWARE_INFO_REPLY]	= kvaser_fsize(u.leaf.softinfo),
321 	[CMD_RX_STD_MESSAGE]		= kvaser_fsize(u.leaf.rx_can),
322 	[CMD_RX_EXT_MESSAGE]		= kvaser_fsize(u.leaf.rx_can),
323 	[CMD_LEAF_LOG_MESSAGE]		= kvaser_fsize(u.leaf.log_message),
324 	[CMD_CHIP_STATE_EVENT]		= kvaser_fsize(u.leaf.chip_state_event),
325 	[CMD_CAN_ERROR_EVENT]		= kvaser_fsize(u.leaf.error_event),
326 	/* ignored events: */
327 	[CMD_FLUSH_QUEUE_REPLY]		= CMD_SIZE_ANY,
328 };
329 
330 static const u8 kvaser_usb_leaf_cmd_sizes_usbcan[] = {
331 	[CMD_START_CHIP_REPLY]		= kvaser_fsize(u.simple),
332 	[CMD_STOP_CHIP_REPLY]		= kvaser_fsize(u.simple),
333 	[CMD_GET_CARD_INFO_REPLY]	= kvaser_fsize(u.cardinfo),
334 	[CMD_TX_ACKNOWLEDGE]		= kvaser_fsize(u.tx_acknowledge_header),
335 	[CMD_GET_SOFTWARE_INFO_REPLY]	= kvaser_fsize(u.usbcan.softinfo),
336 	[CMD_RX_STD_MESSAGE]		= kvaser_fsize(u.usbcan.rx_can),
337 	[CMD_RX_EXT_MESSAGE]		= kvaser_fsize(u.usbcan.rx_can),
338 	[CMD_CHIP_STATE_EVENT]		= kvaser_fsize(u.usbcan.chip_state_event),
339 	[CMD_CAN_ERROR_EVENT]		= kvaser_fsize(u.usbcan.error_event),
340 	/* ignored events: */
341 	[CMD_USBCAN_CLOCK_OVERFLOW_EVENT] = CMD_SIZE_ANY,
342 };
343 
344 /* Summary of a kvaser error event, for a unified Leaf/Usbcan error
345  * handling. Some discrepancies between the two families exist:
346  *
347  * - USBCAN firmware does not report M16C "error factors"
348  * - USBCAN controllers has difficulties reporting if the raised error
349  *   event is for ch0 or ch1. They leave such arbitration to the OS
350  *   driver by letting it compare error counters with previous values
351  *   and decide the error event's channel. Thus for USBCAN, the channel
352  *   field is only advisory.
353  */
354 struct kvaser_usb_err_summary {
355 	u8 channel, status, txerr, rxerr;
356 	union {
357 		struct {
358 			u8 error_factor;
359 		} leaf;
360 		struct {
361 			u8 other_ch_status;
362 			u8 error_state;
363 		} usbcan;
364 	};
365 };
366 
367 static const struct can_bittiming_const kvaser_usb_leaf_m16c_bittiming_const = {
368 	.name = "kvaser_usb_ucii",
369 	.tseg1_min = 4,
370 	.tseg1_max = 16,
371 	.tseg2_min = 2,
372 	.tseg2_max = 8,
373 	.sjw_max = 4,
374 	.brp_min = 1,
375 	.brp_max = 16,
376 	.brp_inc = 1,
377 };
378 
379 static const struct can_bittiming_const kvaser_usb_leaf_m32c_bittiming_const = {
380 	.name = "kvaser_usb_leaf",
381 	.tseg1_min = 3,
382 	.tseg1_max = 16,
383 	.tseg2_min = 2,
384 	.tseg2_max = 8,
385 	.sjw_max = 4,
386 	.brp_min = 2,
387 	.brp_max = 128,
388 	.brp_inc = 2,
389 };
390 
391 static const struct kvaser_usb_dev_cfg kvaser_usb_leaf_usbcan_dev_cfg = {
392 	.clock = {
393 		.freq = 8000000,
394 	},
395 	.timestamp_freq = 1,
396 	.bittiming_const = &kvaser_usb_leaf_m16c_bittiming_const,
397 };
398 
399 static const struct kvaser_usb_dev_cfg kvaser_usb_leaf_m32c_dev_cfg = {
400 	.clock = {
401 		.freq = 16000000,
402 	},
403 	.timestamp_freq = 1,
404 	.bittiming_const = &kvaser_usb_leaf_m32c_bittiming_const,
405 };
406 
407 static const struct kvaser_usb_dev_cfg kvaser_usb_leaf_imx_dev_cfg_16mhz = {
408 	.clock = {
409 		.freq = 16000000,
410 	},
411 	.timestamp_freq = 1,
412 	.bittiming_const = &kvaser_usb_flexc_bittiming_const,
413 };
414 
415 static const struct kvaser_usb_dev_cfg kvaser_usb_leaf_imx_dev_cfg_24mhz = {
416 	.clock = {
417 		.freq = 24000000,
418 	},
419 	.timestamp_freq = 1,
420 	.bittiming_const = &kvaser_usb_flexc_bittiming_const,
421 };
422 
423 static const struct kvaser_usb_dev_cfg kvaser_usb_leaf_imx_dev_cfg_32mhz = {
424 	.clock = {
425 		.freq = 32000000,
426 	},
427 	.timestamp_freq = 1,
428 	.bittiming_const = &kvaser_usb_flexc_bittiming_const,
429 };
430 
kvaser_usb_leaf_verify_size(const struct kvaser_usb * dev,const struct kvaser_cmd * cmd)431 static int kvaser_usb_leaf_verify_size(const struct kvaser_usb *dev,
432 				       const struct kvaser_cmd *cmd)
433 {
434 	/* buffer size >= cmd->len ensured by caller */
435 	u8 min_size = 0;
436 
437 	switch (dev->driver_info->family) {
438 	case KVASER_LEAF:
439 		if (cmd->id < ARRAY_SIZE(kvaser_usb_leaf_cmd_sizes_leaf))
440 			min_size = kvaser_usb_leaf_cmd_sizes_leaf[cmd->id];
441 		break;
442 	case KVASER_USBCAN:
443 		if (cmd->id < ARRAY_SIZE(kvaser_usb_leaf_cmd_sizes_usbcan))
444 			min_size = kvaser_usb_leaf_cmd_sizes_usbcan[cmd->id];
445 		break;
446 	}
447 
448 	if (min_size == CMD_SIZE_ANY)
449 		return 0;
450 
451 	if (min_size) {
452 		min_size += CMD_HEADER_LEN;
453 		if (cmd->len >= min_size)
454 			return 0;
455 
456 		dev_err_ratelimited(&dev->intf->dev,
457 				    "Received command %u too short (size %u, needed %u)",
458 				    cmd->id, cmd->len, min_size);
459 		return -EIO;
460 	}
461 
462 	dev_warn_ratelimited(&dev->intf->dev,
463 			     "Unhandled command (%d, size %d)\n",
464 			     cmd->id, cmd->len);
465 	return -EINVAL;
466 }
467 
468 static void *
kvaser_usb_leaf_frame_to_cmd(const struct kvaser_usb_net_priv * priv,const struct sk_buff * skb,int * frame_len,int * cmd_len,u16 transid)469 kvaser_usb_leaf_frame_to_cmd(const struct kvaser_usb_net_priv *priv,
470 			     const struct sk_buff *skb, int *frame_len,
471 			     int *cmd_len, u16 transid)
472 {
473 	struct kvaser_usb *dev = priv->dev;
474 	struct kvaser_cmd *cmd;
475 	u8 *cmd_tx_can_flags = NULL;		/* GCC */
476 	struct can_frame *cf = (struct can_frame *)skb->data;
477 
478 	*frame_len = cf->can_dlc;
479 
480 	cmd = kmalloc(sizeof(*cmd), GFP_ATOMIC);
481 	if (cmd) {
482 		cmd->u.tx_can.tid = transid & 0xff;
483 		cmd->len = *cmd_len = CMD_HEADER_LEN +
484 				      sizeof(struct kvaser_cmd_tx_can);
485 		cmd->u.tx_can.channel = priv->channel;
486 
487 		switch (dev->driver_info->family) {
488 		case KVASER_LEAF:
489 			cmd_tx_can_flags = &cmd->u.tx_can.leaf.flags;
490 			break;
491 		case KVASER_USBCAN:
492 			cmd_tx_can_flags = &cmd->u.tx_can.usbcan.flags;
493 			break;
494 		}
495 
496 		*cmd_tx_can_flags = 0;
497 
498 		if (cf->can_id & CAN_EFF_FLAG) {
499 			cmd->id = CMD_TX_EXT_MESSAGE;
500 			cmd->u.tx_can.data[0] = (cf->can_id >> 24) & 0x1f;
501 			cmd->u.tx_can.data[1] = (cf->can_id >> 18) & 0x3f;
502 			cmd->u.tx_can.data[2] = (cf->can_id >> 14) & 0x0f;
503 			cmd->u.tx_can.data[3] = (cf->can_id >> 6) & 0xff;
504 			cmd->u.tx_can.data[4] = cf->can_id & 0x3f;
505 		} else {
506 			cmd->id = CMD_TX_STD_MESSAGE;
507 			cmd->u.tx_can.data[0] = (cf->can_id >> 6) & 0x1f;
508 			cmd->u.tx_can.data[1] = cf->can_id & 0x3f;
509 		}
510 
511 		cmd->u.tx_can.data[5] = cf->can_dlc;
512 		memcpy(&cmd->u.tx_can.data[6], cf->data, cf->can_dlc);
513 
514 		if (cf->can_id & CAN_RTR_FLAG)
515 			*cmd_tx_can_flags |= MSG_FLAG_REMOTE_FRAME;
516 	}
517 	return cmd;
518 }
519 
kvaser_usb_leaf_wait_cmd(const struct kvaser_usb * dev,u8 id,struct kvaser_cmd * cmd)520 static int kvaser_usb_leaf_wait_cmd(const struct kvaser_usb *dev, u8 id,
521 				    struct kvaser_cmd *cmd)
522 {
523 	struct kvaser_cmd *tmp;
524 	void *buf;
525 	int actual_len;
526 	int err;
527 	int pos;
528 	unsigned long to = jiffies + msecs_to_jiffies(KVASER_USB_TIMEOUT);
529 
530 	buf = kzalloc(KVASER_USB_RX_BUFFER_SIZE, GFP_KERNEL);
531 	if (!buf)
532 		return -ENOMEM;
533 
534 	do {
535 		err = kvaser_usb_recv_cmd(dev, buf, KVASER_USB_RX_BUFFER_SIZE,
536 					  &actual_len);
537 		if (err < 0)
538 			goto end;
539 
540 		pos = 0;
541 		while (pos <= actual_len - CMD_HEADER_LEN) {
542 			tmp = buf + pos;
543 
544 			/* Handle commands crossing the USB endpoint max packet
545 			 * size boundary. Check kvaser_usb_read_bulk_callback()
546 			 * for further details.
547 			 */
548 			if (tmp->len == 0) {
549 				pos = round_up(pos,
550 					       le16_to_cpu
551 						(dev->bulk_in->wMaxPacketSize));
552 				continue;
553 			}
554 
555 			if (pos + tmp->len > actual_len) {
556 				dev_err_ratelimited(&dev->intf->dev,
557 						    "Format error\n");
558 				break;
559 			}
560 
561 			if (tmp->id == id) {
562 				memcpy(cmd, tmp, tmp->len);
563 				goto end;
564 			}
565 
566 			pos += tmp->len;
567 		}
568 	} while (time_before(jiffies, to));
569 
570 	err = -EINVAL;
571 
572 end:
573 	kfree(buf);
574 
575 	if (err == 0)
576 		err = kvaser_usb_leaf_verify_size(dev, cmd);
577 
578 	return err;
579 }
580 
kvaser_usb_leaf_send_simple_cmd(const struct kvaser_usb * dev,u8 cmd_id,int channel)581 static int kvaser_usb_leaf_send_simple_cmd(const struct kvaser_usb *dev,
582 					   u8 cmd_id, int channel)
583 {
584 	struct kvaser_cmd *cmd;
585 	int rc;
586 
587 	cmd = kmalloc(sizeof(*cmd), GFP_KERNEL);
588 	if (!cmd)
589 		return -ENOMEM;
590 
591 	cmd->id = cmd_id;
592 	cmd->len = CMD_HEADER_LEN + sizeof(struct kvaser_cmd_simple);
593 	cmd->u.simple.channel = channel;
594 	cmd->u.simple.tid = 0xff;
595 
596 	rc = kvaser_usb_send_cmd(dev, cmd, cmd->len);
597 
598 	kfree(cmd);
599 	return rc;
600 }
601 
kvaser_usb_leaf_get_software_info_leaf(struct kvaser_usb * dev,const struct leaf_cmd_softinfo * softinfo)602 static void kvaser_usb_leaf_get_software_info_leaf(struct kvaser_usb *dev,
603 						   const struct leaf_cmd_softinfo *softinfo)
604 {
605 	u32 sw_options = le32_to_cpu(softinfo->sw_options);
606 
607 	dev->fw_version = le32_to_cpu(softinfo->fw_version);
608 	dev->max_tx_urbs = le16_to_cpu(softinfo->max_outstanding_tx);
609 
610 	if (dev->driver_info->quirks & KVASER_USB_QUIRK_IGNORE_CLK_FREQ) {
611 		/* Firmware expects bittiming parameters calculated for 16MHz
612 		 * clock, regardless of the actual clock
613 		 */
614 		dev->cfg = &kvaser_usb_leaf_m32c_dev_cfg;
615 	} else {
616 		switch (sw_options & KVASER_USB_LEAF_SWOPTION_FREQ_MASK) {
617 		case KVASER_USB_LEAF_SWOPTION_FREQ_16_MHZ_CLK:
618 			dev->cfg = &kvaser_usb_leaf_imx_dev_cfg_16mhz;
619 			break;
620 		case KVASER_USB_LEAF_SWOPTION_FREQ_24_MHZ_CLK:
621 			dev->cfg = &kvaser_usb_leaf_imx_dev_cfg_24mhz;
622 			break;
623 		case KVASER_USB_LEAF_SWOPTION_FREQ_32_MHZ_CLK:
624 			dev->cfg = &kvaser_usb_leaf_imx_dev_cfg_32mhz;
625 			break;
626 		}
627 	}
628 }
629 
kvaser_usb_leaf_get_software_info_inner(struct kvaser_usb * dev)630 static int kvaser_usb_leaf_get_software_info_inner(struct kvaser_usb *dev)
631 {
632 	struct kvaser_cmd cmd;
633 	int err;
634 
635 	err = kvaser_usb_leaf_send_simple_cmd(dev, CMD_GET_SOFTWARE_INFO, 0);
636 	if (err)
637 		return err;
638 
639 	err = kvaser_usb_leaf_wait_cmd(dev, CMD_GET_SOFTWARE_INFO_REPLY, &cmd);
640 	if (err)
641 		return err;
642 
643 	switch (dev->driver_info->family) {
644 	case KVASER_LEAF:
645 		kvaser_usb_leaf_get_software_info_leaf(dev, &cmd.u.leaf.softinfo);
646 		break;
647 	case KVASER_USBCAN:
648 		dev->fw_version = le32_to_cpu(cmd.u.usbcan.softinfo.fw_version);
649 		dev->max_tx_urbs =
650 			le16_to_cpu(cmd.u.usbcan.softinfo.max_outstanding_tx);
651 		dev->cfg = &kvaser_usb_leaf_usbcan_dev_cfg;
652 		break;
653 	}
654 
655 	return 0;
656 }
657 
kvaser_usb_leaf_get_software_info(struct kvaser_usb * dev)658 static int kvaser_usb_leaf_get_software_info(struct kvaser_usb *dev)
659 {
660 	int err;
661 	int retry = 3;
662 
663 	/* On some x86 laptops, plugging a Kvaser device again after
664 	 * an unplug makes the firmware always ignore the very first
665 	 * command. For such a case, provide some room for retries
666 	 * instead of completely exiting the driver.
667 	 */
668 	do {
669 		err = kvaser_usb_leaf_get_software_info_inner(dev);
670 	} while (--retry && err == -ETIMEDOUT);
671 
672 	return err;
673 }
674 
kvaser_usb_leaf_get_card_info(struct kvaser_usb * dev)675 static int kvaser_usb_leaf_get_card_info(struct kvaser_usb *dev)
676 {
677 	struct kvaser_cmd cmd;
678 	int err;
679 
680 	err = kvaser_usb_leaf_send_simple_cmd(dev, CMD_GET_CARD_INFO, 0);
681 	if (err)
682 		return err;
683 
684 	err = kvaser_usb_leaf_wait_cmd(dev, CMD_GET_CARD_INFO_REPLY, &cmd);
685 	if (err)
686 		return err;
687 
688 	dev->nchannels = cmd.u.cardinfo.nchannels;
689 	if (dev->nchannels > KVASER_USB_MAX_NET_DEVICES ||
690 	    (dev->driver_info->family == KVASER_USBCAN &&
691 	     dev->nchannels > MAX_USBCAN_NET_DEVICES))
692 		return -EINVAL;
693 
694 	return 0;
695 }
696 
kvaser_usb_leaf_tx_acknowledge(const struct kvaser_usb * dev,const struct kvaser_cmd * cmd)697 static void kvaser_usb_leaf_tx_acknowledge(const struct kvaser_usb *dev,
698 					   const struct kvaser_cmd *cmd)
699 {
700 	struct net_device_stats *stats;
701 	struct kvaser_usb_tx_urb_context *context;
702 	struct kvaser_usb_net_priv *priv;
703 	unsigned long flags;
704 	u8 channel, tid;
705 
706 	channel = cmd->u.tx_acknowledge_header.channel;
707 	tid = cmd->u.tx_acknowledge_header.tid;
708 
709 	if (channel >= dev->nchannels) {
710 		dev_err(&dev->intf->dev,
711 			"Invalid channel number (%d)\n", channel);
712 		return;
713 	}
714 
715 	priv = dev->nets[channel];
716 
717 	if (!netif_device_present(priv->netdev))
718 		return;
719 
720 	stats = &priv->netdev->stats;
721 
722 	context = &priv->tx_contexts[tid % dev->max_tx_urbs];
723 
724 	/* Sometimes the state change doesn't come after a bus-off event */
725 	if (priv->can.restart_ms && priv->can.state >= CAN_STATE_BUS_OFF) {
726 		struct sk_buff *skb;
727 		struct can_frame *cf;
728 
729 		skb = alloc_can_err_skb(priv->netdev, &cf);
730 		if (skb) {
731 			cf->can_id |= CAN_ERR_RESTARTED;
732 
733 			stats->rx_packets++;
734 			stats->rx_bytes += cf->can_dlc;
735 			netif_rx(skb);
736 		} else {
737 			netdev_err(priv->netdev,
738 				   "No memory left for err_skb\n");
739 		}
740 
741 		priv->can.can_stats.restarts++;
742 		netif_carrier_on(priv->netdev);
743 
744 		priv->can.state = CAN_STATE_ERROR_ACTIVE;
745 	}
746 
747 	stats->tx_packets++;
748 	stats->tx_bytes += context->dlc;
749 
750 	spin_lock_irqsave(&priv->tx_contexts_lock, flags);
751 
752 	can_get_echo_skb(priv->netdev, context->echo_index);
753 	context->echo_index = dev->max_tx_urbs;
754 	--priv->active_tx_contexts;
755 	netif_wake_queue(priv->netdev);
756 
757 	spin_unlock_irqrestore(&priv->tx_contexts_lock, flags);
758 }
759 
kvaser_usb_leaf_simple_cmd_async(struct kvaser_usb_net_priv * priv,u8 cmd_id)760 static int kvaser_usb_leaf_simple_cmd_async(struct kvaser_usb_net_priv *priv,
761 					    u8 cmd_id)
762 {
763 	struct kvaser_cmd *cmd;
764 	int err;
765 
766 	cmd = kzalloc(sizeof(*cmd), GFP_ATOMIC);
767 	if (!cmd)
768 		return -ENOMEM;
769 
770 	cmd->len = CMD_HEADER_LEN + sizeof(struct kvaser_cmd_simple);
771 	cmd->id = cmd_id;
772 	cmd->u.simple.channel = priv->channel;
773 
774 	err = kvaser_usb_send_cmd_async(priv, cmd, cmd->len);
775 	if (err)
776 		kfree(cmd);
777 
778 	return err;
779 }
780 
781 static void
kvaser_usb_leaf_rx_error_update_can_state(struct kvaser_usb_net_priv * priv,const struct kvaser_usb_err_summary * es,struct can_frame * cf)782 kvaser_usb_leaf_rx_error_update_can_state(struct kvaser_usb_net_priv *priv,
783 					const struct kvaser_usb_err_summary *es,
784 					struct can_frame *cf)
785 {
786 	struct kvaser_usb *dev = priv->dev;
787 	struct net_device_stats *stats = &priv->netdev->stats;
788 	enum can_state cur_state, new_state, tx_state, rx_state;
789 
790 	netdev_dbg(priv->netdev, "Error status: 0x%02x\n", es->status);
791 
792 	new_state = priv->can.state;
793 	cur_state = priv->can.state;
794 
795 	if (es->status & (M16C_STATE_BUS_OFF | M16C_STATE_BUS_RESET)) {
796 		new_state = CAN_STATE_BUS_OFF;
797 	} else if (es->status & M16C_STATE_BUS_PASSIVE) {
798 		new_state = CAN_STATE_ERROR_PASSIVE;
799 	} else if (es->status & M16C_STATE_BUS_ERROR) {
800 		/* Guard against spurious error events after a busoff */
801 		if (cur_state < CAN_STATE_BUS_OFF) {
802 			if (es->txerr >= 128 || es->rxerr >= 128)
803 				new_state = CAN_STATE_ERROR_PASSIVE;
804 			else if (es->txerr >= 96 || es->rxerr >= 96)
805 				new_state = CAN_STATE_ERROR_WARNING;
806 			else if (cur_state > CAN_STATE_ERROR_ACTIVE)
807 				new_state = CAN_STATE_ERROR_ACTIVE;
808 		}
809 	}
810 
811 	if (!es->status)
812 		new_state = CAN_STATE_ERROR_ACTIVE;
813 
814 	if (new_state != cur_state) {
815 		tx_state = (es->txerr >= es->rxerr) ? new_state : 0;
816 		rx_state = (es->txerr <= es->rxerr) ? new_state : 0;
817 
818 		can_change_state(priv->netdev, cf, tx_state, rx_state);
819 	}
820 
821 	if (priv->can.restart_ms &&
822 	    cur_state >= CAN_STATE_BUS_OFF &&
823 	    new_state < CAN_STATE_BUS_OFF)
824 		priv->can.can_stats.restarts++;
825 
826 	switch (dev->driver_info->family) {
827 	case KVASER_LEAF:
828 		if (es->leaf.error_factor) {
829 			priv->can.can_stats.bus_error++;
830 			stats->rx_errors++;
831 		}
832 		break;
833 	case KVASER_USBCAN:
834 		if (es->usbcan.error_state & USBCAN_ERROR_STATE_TX_ERROR)
835 			stats->tx_errors++;
836 		if (es->usbcan.error_state & USBCAN_ERROR_STATE_RX_ERROR)
837 			stats->rx_errors++;
838 		if (es->usbcan.error_state & USBCAN_ERROR_STATE_BUSERROR)
839 			priv->can.can_stats.bus_error++;
840 		break;
841 	}
842 
843 	priv->bec.txerr = es->txerr;
844 	priv->bec.rxerr = es->rxerr;
845 }
846 
kvaser_usb_leaf_rx_error(const struct kvaser_usb * dev,const struct kvaser_usb_err_summary * es)847 static void kvaser_usb_leaf_rx_error(const struct kvaser_usb *dev,
848 				     const struct kvaser_usb_err_summary *es)
849 {
850 	struct can_frame *cf;
851 	struct can_frame tmp_cf = { .can_id = CAN_ERR_FLAG,
852 				    .can_dlc = CAN_ERR_DLC };
853 	struct sk_buff *skb;
854 	struct net_device_stats *stats;
855 	struct kvaser_usb_net_priv *priv;
856 	enum can_state old_state, new_state;
857 
858 	if (es->channel >= dev->nchannels) {
859 		dev_err(&dev->intf->dev,
860 			"Invalid channel number (%d)\n", es->channel);
861 		return;
862 	}
863 
864 	priv = dev->nets[es->channel];
865 	stats = &priv->netdev->stats;
866 
867 	/* Update all of the CAN interface's state and error counters before
868 	 * trying any memory allocation that can actually fail with -ENOMEM.
869 	 *
870 	 * We send a temporary stack-allocated error CAN frame to
871 	 * can_change_state() for the very same reason.
872 	 *
873 	 * TODO: Split can_change_state() responsibility between updating the
874 	 * CAN interface's state and counters, and the setting up of CAN error
875 	 * frame ID and data to userspace. Remove stack allocation afterwards.
876 	 */
877 	old_state = priv->can.state;
878 	kvaser_usb_leaf_rx_error_update_can_state(priv, es, &tmp_cf);
879 	new_state = priv->can.state;
880 
881 	skb = alloc_can_err_skb(priv->netdev, &cf);
882 	if (!skb) {
883 		stats->rx_dropped++;
884 		return;
885 	}
886 	memcpy(cf, &tmp_cf, sizeof(*cf));
887 
888 	if (new_state != old_state) {
889 		if (es->status &
890 		    (M16C_STATE_BUS_OFF | M16C_STATE_BUS_RESET)) {
891 			if (!priv->can.restart_ms)
892 				kvaser_usb_leaf_simple_cmd_async(priv,
893 								 CMD_STOP_CHIP);
894 			netif_carrier_off(priv->netdev);
895 		}
896 
897 		if (priv->can.restart_ms &&
898 		    old_state >= CAN_STATE_BUS_OFF &&
899 		    new_state < CAN_STATE_BUS_OFF) {
900 			cf->can_id |= CAN_ERR_RESTARTED;
901 			netif_carrier_on(priv->netdev);
902 		}
903 	}
904 
905 	switch (dev->driver_info->family) {
906 	case KVASER_LEAF:
907 		if (es->leaf.error_factor) {
908 			cf->can_id |= CAN_ERR_BUSERROR | CAN_ERR_PROT;
909 
910 			if (es->leaf.error_factor & M16C_EF_ACKE)
911 				cf->data[3] = CAN_ERR_PROT_LOC_ACK;
912 			if (es->leaf.error_factor & M16C_EF_CRCE)
913 				cf->data[3] = CAN_ERR_PROT_LOC_CRC_SEQ;
914 			if (es->leaf.error_factor & M16C_EF_FORME)
915 				cf->data[2] |= CAN_ERR_PROT_FORM;
916 			if (es->leaf.error_factor & M16C_EF_STFE)
917 				cf->data[2] |= CAN_ERR_PROT_STUFF;
918 			if (es->leaf.error_factor & M16C_EF_BITE0)
919 				cf->data[2] |= CAN_ERR_PROT_BIT0;
920 			if (es->leaf.error_factor & M16C_EF_BITE1)
921 				cf->data[2] |= CAN_ERR_PROT_BIT1;
922 			if (es->leaf.error_factor & M16C_EF_TRE)
923 				cf->data[2] |= CAN_ERR_PROT_TX;
924 		}
925 		break;
926 	case KVASER_USBCAN:
927 		if (es->usbcan.error_state & USBCAN_ERROR_STATE_BUSERROR)
928 			cf->can_id |= CAN_ERR_BUSERROR;
929 		break;
930 	}
931 
932 	if (new_state != CAN_STATE_BUS_OFF) {
933 		cf->data[6] = es->txerr;
934 		cf->data[7] = es->rxerr;
935 	}
936 
937 	stats->rx_packets++;
938 	stats->rx_bytes += cf->can_dlc;
939 	netif_rx(skb);
940 }
941 
942 /* For USBCAN, report error to userspace if the channels's errors counter
943  * has changed, or we're the only channel seeing a bus error state.
944  */
945 static void
kvaser_usb_leaf_usbcan_conditionally_rx_error(const struct kvaser_usb * dev,struct kvaser_usb_err_summary * es)946 kvaser_usb_leaf_usbcan_conditionally_rx_error(const struct kvaser_usb *dev,
947 					      struct kvaser_usb_err_summary *es)
948 {
949 	struct kvaser_usb_net_priv *priv;
950 	unsigned int channel;
951 	bool report_error;
952 
953 	channel = es->channel;
954 	if (channel >= dev->nchannels) {
955 		dev_err(&dev->intf->dev,
956 			"Invalid channel number (%d)\n", channel);
957 		return;
958 	}
959 
960 	priv = dev->nets[channel];
961 	report_error = false;
962 
963 	if (es->txerr != priv->bec.txerr) {
964 		es->usbcan.error_state |= USBCAN_ERROR_STATE_TX_ERROR;
965 		report_error = true;
966 	}
967 	if (es->rxerr != priv->bec.rxerr) {
968 		es->usbcan.error_state |= USBCAN_ERROR_STATE_RX_ERROR;
969 		report_error = true;
970 	}
971 	if ((es->status & M16C_STATE_BUS_ERROR) &&
972 	    !(es->usbcan.other_ch_status & M16C_STATE_BUS_ERROR)) {
973 		es->usbcan.error_state |= USBCAN_ERROR_STATE_BUSERROR;
974 		report_error = true;
975 	}
976 
977 	if (report_error)
978 		kvaser_usb_leaf_rx_error(dev, es);
979 }
980 
kvaser_usb_leaf_usbcan_rx_error(const struct kvaser_usb * dev,const struct kvaser_cmd * cmd)981 static void kvaser_usb_leaf_usbcan_rx_error(const struct kvaser_usb *dev,
982 					    const struct kvaser_cmd *cmd)
983 {
984 	struct kvaser_usb_err_summary es = { };
985 
986 	switch (cmd->id) {
987 	/* Sometimes errors are sent as unsolicited chip state events */
988 	case CMD_CHIP_STATE_EVENT:
989 		es.channel = cmd->u.usbcan.chip_state_event.channel;
990 		es.status = cmd->u.usbcan.chip_state_event.status;
991 		es.txerr = cmd->u.usbcan.chip_state_event.tx_errors_count;
992 		es.rxerr = cmd->u.usbcan.chip_state_event.rx_errors_count;
993 		kvaser_usb_leaf_usbcan_conditionally_rx_error(dev, &es);
994 		break;
995 
996 	case CMD_CAN_ERROR_EVENT:
997 		es.channel = 0;
998 		es.status = cmd->u.usbcan.error_event.status_ch0;
999 		es.txerr = cmd->u.usbcan.error_event.tx_errors_count_ch0;
1000 		es.rxerr = cmd->u.usbcan.error_event.rx_errors_count_ch0;
1001 		es.usbcan.other_ch_status =
1002 			cmd->u.usbcan.error_event.status_ch1;
1003 		kvaser_usb_leaf_usbcan_conditionally_rx_error(dev, &es);
1004 
1005 		/* The USBCAN firmware supports up to 2 channels.
1006 		 * Now that ch0 was checked, check if ch1 has any errors.
1007 		 */
1008 		if (dev->nchannels == MAX_USBCAN_NET_DEVICES) {
1009 			es.channel = 1;
1010 			es.status = cmd->u.usbcan.error_event.status_ch1;
1011 			es.txerr =
1012 				cmd->u.usbcan.error_event.tx_errors_count_ch1;
1013 			es.rxerr =
1014 				cmd->u.usbcan.error_event.rx_errors_count_ch1;
1015 			es.usbcan.other_ch_status =
1016 				cmd->u.usbcan.error_event.status_ch0;
1017 			kvaser_usb_leaf_usbcan_conditionally_rx_error(dev, &es);
1018 		}
1019 		break;
1020 
1021 	default:
1022 		dev_err(&dev->intf->dev, "Invalid cmd id (%d)\n", cmd->id);
1023 	}
1024 }
1025 
kvaser_usb_leaf_leaf_rx_error(const struct kvaser_usb * dev,const struct kvaser_cmd * cmd)1026 static void kvaser_usb_leaf_leaf_rx_error(const struct kvaser_usb *dev,
1027 					  const struct kvaser_cmd *cmd)
1028 {
1029 	struct kvaser_usb_err_summary es = { };
1030 
1031 	switch (cmd->id) {
1032 	case CMD_CAN_ERROR_EVENT:
1033 		es.channel = cmd->u.leaf.error_event.channel;
1034 		es.status = cmd->u.leaf.error_event.status;
1035 		es.txerr = cmd->u.leaf.error_event.tx_errors_count;
1036 		es.rxerr = cmd->u.leaf.error_event.rx_errors_count;
1037 		es.leaf.error_factor = cmd->u.leaf.error_event.error_factor;
1038 		break;
1039 	case CMD_LEAF_LOG_MESSAGE:
1040 		es.channel = cmd->u.leaf.log_message.channel;
1041 		es.status = cmd->u.leaf.log_message.data[0];
1042 		es.txerr = cmd->u.leaf.log_message.data[2];
1043 		es.rxerr = cmd->u.leaf.log_message.data[3];
1044 		es.leaf.error_factor = cmd->u.leaf.log_message.data[1];
1045 		break;
1046 	case CMD_CHIP_STATE_EVENT:
1047 		es.channel = cmd->u.leaf.chip_state_event.channel;
1048 		es.status = cmd->u.leaf.chip_state_event.status;
1049 		es.txerr = cmd->u.leaf.chip_state_event.tx_errors_count;
1050 		es.rxerr = cmd->u.leaf.chip_state_event.rx_errors_count;
1051 		es.leaf.error_factor = 0;
1052 		break;
1053 	default:
1054 		dev_err(&dev->intf->dev, "Invalid cmd id (%d)\n", cmd->id);
1055 		return;
1056 	}
1057 
1058 	kvaser_usb_leaf_rx_error(dev, &es);
1059 }
1060 
kvaser_usb_leaf_rx_can_err(const struct kvaser_usb_net_priv * priv,const struct kvaser_cmd * cmd)1061 static void kvaser_usb_leaf_rx_can_err(const struct kvaser_usb_net_priv *priv,
1062 				       const struct kvaser_cmd *cmd)
1063 {
1064 	if (cmd->u.rx_can_header.flag & (MSG_FLAG_ERROR_FRAME |
1065 					 MSG_FLAG_NERR)) {
1066 		struct net_device_stats *stats = &priv->netdev->stats;
1067 
1068 		netdev_err(priv->netdev, "Unknown error (flags: 0x%02x)\n",
1069 			   cmd->u.rx_can_header.flag);
1070 
1071 		stats->rx_errors++;
1072 		return;
1073 	}
1074 
1075 	if (cmd->u.rx_can_header.flag & MSG_FLAG_OVERRUN)
1076 		kvaser_usb_can_rx_over_error(priv->netdev);
1077 }
1078 
kvaser_usb_leaf_rx_can_msg(const struct kvaser_usb * dev,const struct kvaser_cmd * cmd)1079 static void kvaser_usb_leaf_rx_can_msg(const struct kvaser_usb *dev,
1080 				       const struct kvaser_cmd *cmd)
1081 {
1082 	struct kvaser_usb_net_priv *priv;
1083 	struct can_frame *cf;
1084 	struct sk_buff *skb;
1085 	struct net_device_stats *stats;
1086 	u8 channel = cmd->u.rx_can_header.channel;
1087 	const u8 *rx_data = NULL;	/* GCC */
1088 
1089 	if (channel >= dev->nchannels) {
1090 		dev_err(&dev->intf->dev,
1091 			"Invalid channel number (%d)\n", channel);
1092 		return;
1093 	}
1094 
1095 	priv = dev->nets[channel];
1096 	stats = &priv->netdev->stats;
1097 
1098 	if ((cmd->u.rx_can_header.flag & MSG_FLAG_ERROR_FRAME) &&
1099 	    (dev->driver_info->family == KVASER_LEAF &&
1100 	     cmd->id == CMD_LEAF_LOG_MESSAGE)) {
1101 		kvaser_usb_leaf_leaf_rx_error(dev, cmd);
1102 		return;
1103 	} else if (cmd->u.rx_can_header.flag & (MSG_FLAG_ERROR_FRAME |
1104 						MSG_FLAG_NERR |
1105 						MSG_FLAG_OVERRUN)) {
1106 		kvaser_usb_leaf_rx_can_err(priv, cmd);
1107 		return;
1108 	} else if (cmd->u.rx_can_header.flag & ~MSG_FLAG_REMOTE_FRAME) {
1109 		netdev_warn(priv->netdev,
1110 			    "Unhandled frame (flags: 0x%02x)\n",
1111 			    cmd->u.rx_can_header.flag);
1112 		return;
1113 	}
1114 
1115 	switch (dev->driver_info->family) {
1116 	case KVASER_LEAF:
1117 		rx_data = cmd->u.leaf.rx_can.data;
1118 		break;
1119 	case KVASER_USBCAN:
1120 		rx_data = cmd->u.usbcan.rx_can.data;
1121 		break;
1122 	}
1123 
1124 	skb = alloc_can_skb(priv->netdev, &cf);
1125 	if (!skb) {
1126 		stats->rx_dropped++;
1127 		return;
1128 	}
1129 
1130 	if (dev->driver_info->family == KVASER_LEAF && cmd->id ==
1131 	    CMD_LEAF_LOG_MESSAGE) {
1132 		cf->can_id = le32_to_cpu(cmd->u.leaf.log_message.id);
1133 		if (cf->can_id & KVASER_EXTENDED_FRAME)
1134 			cf->can_id &= CAN_EFF_MASK | CAN_EFF_FLAG;
1135 		else
1136 			cf->can_id &= CAN_SFF_MASK;
1137 
1138 		cf->can_dlc = get_can_dlc(cmd->u.leaf.log_message.dlc);
1139 
1140 		if (cmd->u.leaf.log_message.flags & MSG_FLAG_REMOTE_FRAME)
1141 			cf->can_id |= CAN_RTR_FLAG;
1142 		else
1143 			memcpy(cf->data, &cmd->u.leaf.log_message.data,
1144 			       cf->can_dlc);
1145 	} else {
1146 		cf->can_id = ((rx_data[0] & 0x1f) << 6) | (rx_data[1] & 0x3f);
1147 
1148 		if (cmd->id == CMD_RX_EXT_MESSAGE) {
1149 			cf->can_id <<= 18;
1150 			cf->can_id |= ((rx_data[2] & 0x0f) << 14) |
1151 				      ((rx_data[3] & 0xff) << 6) |
1152 				      (rx_data[4] & 0x3f);
1153 			cf->can_id |= CAN_EFF_FLAG;
1154 		}
1155 
1156 		cf->can_dlc = get_can_dlc(rx_data[5]);
1157 
1158 		if (cmd->u.rx_can_header.flag & MSG_FLAG_REMOTE_FRAME)
1159 			cf->can_id |= CAN_RTR_FLAG;
1160 		else
1161 			memcpy(cf->data, &rx_data[6], cf->can_dlc);
1162 	}
1163 
1164 	stats->rx_packets++;
1165 	stats->rx_bytes += cf->can_dlc;
1166 	netif_rx(skb);
1167 }
1168 
kvaser_usb_leaf_start_chip_reply(const struct kvaser_usb * dev,const struct kvaser_cmd * cmd)1169 static void kvaser_usb_leaf_start_chip_reply(const struct kvaser_usb *dev,
1170 					     const struct kvaser_cmd *cmd)
1171 {
1172 	struct kvaser_usb_net_priv *priv;
1173 	u8 channel = cmd->u.simple.channel;
1174 
1175 	if (channel >= dev->nchannels) {
1176 		dev_err(&dev->intf->dev,
1177 			"Invalid channel number (%d)\n", channel);
1178 		return;
1179 	}
1180 
1181 	priv = dev->nets[channel];
1182 
1183 	if (completion_done(&priv->start_comp) &&
1184 	    netif_queue_stopped(priv->netdev)) {
1185 		netif_wake_queue(priv->netdev);
1186 	} else {
1187 		netif_start_queue(priv->netdev);
1188 		complete(&priv->start_comp);
1189 	}
1190 }
1191 
kvaser_usb_leaf_stop_chip_reply(const struct kvaser_usb * dev,const struct kvaser_cmd * cmd)1192 static void kvaser_usb_leaf_stop_chip_reply(const struct kvaser_usb *dev,
1193 					    const struct kvaser_cmd *cmd)
1194 {
1195 	struct kvaser_usb_net_priv *priv;
1196 	u8 channel = cmd->u.simple.channel;
1197 
1198 	if (channel >= dev->nchannels) {
1199 		dev_err(&dev->intf->dev,
1200 			"Invalid channel number (%d)\n", channel);
1201 		return;
1202 	}
1203 
1204 	priv = dev->nets[channel];
1205 
1206 	complete(&priv->stop_comp);
1207 }
1208 
kvaser_usb_leaf_handle_command(const struct kvaser_usb * dev,const struct kvaser_cmd * cmd)1209 static void kvaser_usb_leaf_handle_command(const struct kvaser_usb *dev,
1210 					   const struct kvaser_cmd *cmd)
1211 {
1212 	if (kvaser_usb_leaf_verify_size(dev, cmd) < 0)
1213 		return;
1214 
1215 	switch (cmd->id) {
1216 	case CMD_START_CHIP_REPLY:
1217 		kvaser_usb_leaf_start_chip_reply(dev, cmd);
1218 		break;
1219 
1220 	case CMD_STOP_CHIP_REPLY:
1221 		kvaser_usb_leaf_stop_chip_reply(dev, cmd);
1222 		break;
1223 
1224 	case CMD_RX_STD_MESSAGE:
1225 	case CMD_RX_EXT_MESSAGE:
1226 		kvaser_usb_leaf_rx_can_msg(dev, cmd);
1227 		break;
1228 
1229 	case CMD_LEAF_LOG_MESSAGE:
1230 		if (dev->driver_info->family != KVASER_LEAF)
1231 			goto warn;
1232 		kvaser_usb_leaf_rx_can_msg(dev, cmd);
1233 		break;
1234 
1235 	case CMD_CHIP_STATE_EVENT:
1236 	case CMD_CAN_ERROR_EVENT:
1237 		if (dev->driver_info->family == KVASER_LEAF)
1238 			kvaser_usb_leaf_leaf_rx_error(dev, cmd);
1239 		else
1240 			kvaser_usb_leaf_usbcan_rx_error(dev, cmd);
1241 		break;
1242 
1243 	case CMD_TX_ACKNOWLEDGE:
1244 		kvaser_usb_leaf_tx_acknowledge(dev, cmd);
1245 		break;
1246 
1247 	/* Ignored commands */
1248 	case CMD_USBCAN_CLOCK_OVERFLOW_EVENT:
1249 		if (dev->driver_info->family != KVASER_USBCAN)
1250 			goto warn;
1251 		break;
1252 
1253 	case CMD_FLUSH_QUEUE_REPLY:
1254 		if (dev->driver_info->family != KVASER_LEAF)
1255 			goto warn;
1256 		break;
1257 
1258 	default:
1259 warn:		dev_warn(&dev->intf->dev, "Unhandled command (%d)\n", cmd->id);
1260 		break;
1261 	}
1262 }
1263 
kvaser_usb_leaf_read_bulk_callback(struct kvaser_usb * dev,void * buf,int len)1264 static void kvaser_usb_leaf_read_bulk_callback(struct kvaser_usb *dev,
1265 					       void *buf, int len)
1266 {
1267 	struct kvaser_cmd *cmd;
1268 	int pos = 0;
1269 
1270 	while (pos <= len - CMD_HEADER_LEN) {
1271 		cmd = buf + pos;
1272 
1273 		/* The Kvaser firmware can only read and write commands that
1274 		 * does not cross the USB's endpoint wMaxPacketSize boundary.
1275 		 * If a follow-up command crosses such boundary, firmware puts
1276 		 * a placeholder zero-length command in its place then aligns
1277 		 * the real command to the next max packet size.
1278 		 *
1279 		 * Handle such cases or we're going to miss a significant
1280 		 * number of events in case of a heavy rx load on the bus.
1281 		 */
1282 		if (cmd->len == 0) {
1283 			pos = round_up(pos, le16_to_cpu
1284 						(dev->bulk_in->wMaxPacketSize));
1285 			continue;
1286 		}
1287 
1288 		if (pos + cmd->len > len) {
1289 			dev_err_ratelimited(&dev->intf->dev, "Format error\n");
1290 			break;
1291 		}
1292 
1293 		kvaser_usb_leaf_handle_command(dev, cmd);
1294 		pos += cmd->len;
1295 	}
1296 }
1297 
kvaser_usb_leaf_set_opt_mode(const struct kvaser_usb_net_priv * priv)1298 static int kvaser_usb_leaf_set_opt_mode(const struct kvaser_usb_net_priv *priv)
1299 {
1300 	struct kvaser_cmd *cmd;
1301 	int rc;
1302 
1303 	cmd = kzalloc(sizeof(*cmd), GFP_KERNEL);
1304 	if (!cmd)
1305 		return -ENOMEM;
1306 
1307 	cmd->id = CMD_SET_CTRL_MODE;
1308 	cmd->len = CMD_HEADER_LEN + sizeof(struct kvaser_cmd_ctrl_mode);
1309 	cmd->u.ctrl_mode.tid = 0xff;
1310 	cmd->u.ctrl_mode.channel = priv->channel;
1311 
1312 	if (priv->can.ctrlmode & CAN_CTRLMODE_LISTENONLY)
1313 		cmd->u.ctrl_mode.ctrl_mode = KVASER_CTRL_MODE_SILENT;
1314 	else
1315 		cmd->u.ctrl_mode.ctrl_mode = KVASER_CTRL_MODE_NORMAL;
1316 
1317 	rc = kvaser_usb_send_cmd(priv->dev, cmd, cmd->len);
1318 
1319 	kfree(cmd);
1320 	return rc;
1321 }
1322 
kvaser_usb_leaf_start_chip(struct kvaser_usb_net_priv * priv)1323 static int kvaser_usb_leaf_start_chip(struct kvaser_usb_net_priv *priv)
1324 {
1325 	int err;
1326 
1327 	reinit_completion(&priv->start_comp);
1328 
1329 	err = kvaser_usb_leaf_send_simple_cmd(priv->dev, CMD_START_CHIP,
1330 					      priv->channel);
1331 	if (err)
1332 		return err;
1333 
1334 	if (!wait_for_completion_timeout(&priv->start_comp,
1335 					 msecs_to_jiffies(KVASER_USB_TIMEOUT)))
1336 		return -ETIMEDOUT;
1337 
1338 	return 0;
1339 }
1340 
kvaser_usb_leaf_stop_chip(struct kvaser_usb_net_priv * priv)1341 static int kvaser_usb_leaf_stop_chip(struct kvaser_usb_net_priv *priv)
1342 {
1343 	int err;
1344 
1345 	reinit_completion(&priv->stop_comp);
1346 
1347 	err = kvaser_usb_leaf_send_simple_cmd(priv->dev, CMD_STOP_CHIP,
1348 					      priv->channel);
1349 	if (err)
1350 		return err;
1351 
1352 	if (!wait_for_completion_timeout(&priv->stop_comp,
1353 					 msecs_to_jiffies(KVASER_USB_TIMEOUT)))
1354 		return -ETIMEDOUT;
1355 
1356 	return 0;
1357 }
1358 
kvaser_usb_leaf_reset_chip(struct kvaser_usb * dev,int channel)1359 static int kvaser_usb_leaf_reset_chip(struct kvaser_usb *dev, int channel)
1360 {
1361 	return kvaser_usb_leaf_send_simple_cmd(dev, CMD_RESET_CHIP, channel);
1362 }
1363 
kvaser_usb_leaf_flush_queue(struct kvaser_usb_net_priv * priv)1364 static int kvaser_usb_leaf_flush_queue(struct kvaser_usb_net_priv *priv)
1365 {
1366 	struct kvaser_cmd *cmd;
1367 	int rc;
1368 
1369 	cmd = kzalloc(sizeof(*cmd), GFP_KERNEL);
1370 	if (!cmd)
1371 		return -ENOMEM;
1372 
1373 	cmd->id = CMD_FLUSH_QUEUE;
1374 	cmd->len = CMD_HEADER_LEN + sizeof(struct kvaser_cmd_flush_queue);
1375 	cmd->u.flush_queue.channel = priv->channel;
1376 	cmd->u.flush_queue.flags = 0x00;
1377 
1378 	rc = kvaser_usb_send_cmd(priv->dev, cmd, cmd->len);
1379 
1380 	kfree(cmd);
1381 	return rc;
1382 }
1383 
kvaser_usb_leaf_init_card(struct kvaser_usb * dev)1384 static int kvaser_usb_leaf_init_card(struct kvaser_usb *dev)
1385 {
1386 	struct kvaser_usb_dev_card_data *card_data = &dev->card_data;
1387 
1388 	card_data->ctrlmode_supported |= CAN_CTRLMODE_3_SAMPLES;
1389 
1390 	return 0;
1391 }
1392 
kvaser_usb_leaf_set_bittiming(struct net_device * netdev)1393 static int kvaser_usb_leaf_set_bittiming(struct net_device *netdev)
1394 {
1395 	struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1396 	struct can_bittiming *bt = &priv->can.bittiming;
1397 	struct kvaser_usb *dev = priv->dev;
1398 	struct kvaser_cmd *cmd;
1399 	int rc;
1400 
1401 	cmd = kmalloc(sizeof(*cmd), GFP_KERNEL);
1402 	if (!cmd)
1403 		return -ENOMEM;
1404 
1405 	cmd->id = CMD_SET_BUS_PARAMS;
1406 	cmd->len = CMD_HEADER_LEN + sizeof(struct kvaser_cmd_busparams);
1407 	cmd->u.busparams.channel = priv->channel;
1408 	cmd->u.busparams.tid = 0xff;
1409 	cmd->u.busparams.bitrate = cpu_to_le32(bt->bitrate);
1410 	cmd->u.busparams.sjw = bt->sjw;
1411 	cmd->u.busparams.tseg1 = bt->prop_seg + bt->phase_seg1;
1412 	cmd->u.busparams.tseg2 = bt->phase_seg2;
1413 
1414 	if (priv->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES)
1415 		cmd->u.busparams.no_samp = 3;
1416 	else
1417 		cmd->u.busparams.no_samp = 1;
1418 
1419 	rc = kvaser_usb_send_cmd(dev, cmd, cmd->len);
1420 
1421 	kfree(cmd);
1422 	return rc;
1423 }
1424 
kvaser_usb_leaf_set_mode(struct net_device * netdev,enum can_mode mode)1425 static int kvaser_usb_leaf_set_mode(struct net_device *netdev,
1426 				    enum can_mode mode)
1427 {
1428 	struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1429 	int err;
1430 
1431 	switch (mode) {
1432 	case CAN_MODE_START:
1433 		kvaser_usb_unlink_tx_urbs(priv);
1434 
1435 		err = kvaser_usb_leaf_simple_cmd_async(priv, CMD_START_CHIP);
1436 		if (err)
1437 			return err;
1438 
1439 		priv->can.state = CAN_STATE_ERROR_ACTIVE;
1440 		break;
1441 	default:
1442 		return -EOPNOTSUPP;
1443 	}
1444 
1445 	return 0;
1446 }
1447 
kvaser_usb_leaf_get_berr_counter(const struct net_device * netdev,struct can_berr_counter * bec)1448 static int kvaser_usb_leaf_get_berr_counter(const struct net_device *netdev,
1449 					    struct can_berr_counter *bec)
1450 {
1451 	struct kvaser_usb_net_priv *priv = netdev_priv(netdev);
1452 
1453 	*bec = priv->bec;
1454 
1455 	return 0;
1456 }
1457 
kvaser_usb_leaf_setup_endpoints(struct kvaser_usb * dev)1458 static int kvaser_usb_leaf_setup_endpoints(struct kvaser_usb *dev)
1459 {
1460 	const struct usb_host_interface *iface_desc;
1461 	struct usb_endpoint_descriptor *endpoint;
1462 	int i;
1463 
1464 	iface_desc = dev->intf->cur_altsetting;
1465 
1466 	for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
1467 		endpoint = &iface_desc->endpoint[i].desc;
1468 
1469 		if (!dev->bulk_in && usb_endpoint_is_bulk_in(endpoint))
1470 			dev->bulk_in = endpoint;
1471 
1472 		if (!dev->bulk_out && usb_endpoint_is_bulk_out(endpoint))
1473 			dev->bulk_out = endpoint;
1474 
1475 		/* use first bulk endpoint for in and out */
1476 		if (dev->bulk_in && dev->bulk_out)
1477 			return 0;
1478 	}
1479 
1480 	return -ENODEV;
1481 }
1482 
1483 const struct kvaser_usb_dev_ops kvaser_usb_leaf_dev_ops = {
1484 	.dev_set_mode = kvaser_usb_leaf_set_mode,
1485 	.dev_set_bittiming = kvaser_usb_leaf_set_bittiming,
1486 	.dev_set_data_bittiming = NULL,
1487 	.dev_get_berr_counter = kvaser_usb_leaf_get_berr_counter,
1488 	.dev_setup_endpoints = kvaser_usb_leaf_setup_endpoints,
1489 	.dev_init_card = kvaser_usb_leaf_init_card,
1490 	.dev_get_software_info = kvaser_usb_leaf_get_software_info,
1491 	.dev_get_software_details = NULL,
1492 	.dev_get_card_info = kvaser_usb_leaf_get_card_info,
1493 	.dev_get_capabilities = NULL,
1494 	.dev_set_opt_mode = kvaser_usb_leaf_set_opt_mode,
1495 	.dev_start_chip = kvaser_usb_leaf_start_chip,
1496 	.dev_stop_chip = kvaser_usb_leaf_stop_chip,
1497 	.dev_reset_chip = kvaser_usb_leaf_reset_chip,
1498 	.dev_flush_queue = kvaser_usb_leaf_flush_queue,
1499 	.dev_read_bulk_callback = kvaser_usb_leaf_read_bulk_callback,
1500 	.dev_frame_to_cmd = kvaser_usb_leaf_frame_to_cmd,
1501 };
1502