xref: /openbmc/linux/drivers/net/can/usb/gs_usb.c (revision bc5aa3a0)
1 /* CAN driver for Geschwister Schneider USB/CAN devices
2  * and bytewerk.org candleLight USB CAN interfaces.
3  *
4  * Copyright (C) 2013-2016 Geschwister Schneider Technologie-,
5  * Entwicklungs- und Vertriebs UG (Haftungsbeschränkt).
6  * Copyright (C) 2016 Hubert Denkmair
7  *
8  * Many thanks to all socketcan devs!
9  *
10  * This program is free software; you can redistribute it and/or modify it
11  * under the terms of the GNU General Public License as published
12  * by the Free Software Foundation; version 2 of the License.
13  *
14  * This program is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * General Public License for more details.
18  */
19 
20 #include <linux/init.h>
21 #include <linux/signal.h>
22 #include <linux/module.h>
23 #include <linux/netdevice.h>
24 #include <linux/usb.h>
25 
26 #include <linux/can.h>
27 #include <linux/can/dev.h>
28 #include <linux/can/error.h>
29 
30 /* Device specific constants */
31 #define USB_GSUSB_1_VENDOR_ID      0x1d50
32 #define USB_GSUSB_1_PRODUCT_ID     0x606f
33 
34 #define USB_CANDLELIGHT_VENDOR_ID  0x1209
35 #define USB_CANDLELIGHT_PRODUCT_ID 0x2323
36 
37 #define GSUSB_ENDPOINT_IN          1
38 #define GSUSB_ENDPOINT_OUT         2
39 
40 /* Device specific constants */
41 enum gs_usb_breq {
42 	GS_USB_BREQ_HOST_FORMAT = 0,
43 	GS_USB_BREQ_BITTIMING,
44 	GS_USB_BREQ_MODE,
45 	GS_USB_BREQ_BERR,
46 	GS_USB_BREQ_BT_CONST,
47 	GS_USB_BREQ_DEVICE_CONFIG,
48 	GS_USB_BREQ_TIMESTAMP,
49 	GS_USB_BREQ_IDENTIFY,
50 };
51 
52 enum gs_can_mode {
53 	/* reset a channel. turns it off */
54 	GS_CAN_MODE_RESET = 0,
55 	/* starts a channel */
56 	GS_CAN_MODE_START
57 };
58 
59 enum gs_can_state {
60 	GS_CAN_STATE_ERROR_ACTIVE = 0,
61 	GS_CAN_STATE_ERROR_WARNING,
62 	GS_CAN_STATE_ERROR_PASSIVE,
63 	GS_CAN_STATE_BUS_OFF,
64 	GS_CAN_STATE_STOPPED,
65 	GS_CAN_STATE_SLEEPING
66 };
67 
68 enum gs_can_identify_mode {
69 	GS_CAN_IDENTIFY_OFF = 0,
70 	GS_CAN_IDENTIFY_ON
71 };
72 
73 /* data types passed between host and device */
74 struct gs_host_config {
75 	u32 byte_order;
76 } __packed;
77 /* All data exchanged between host and device is exchanged in host byte order,
78  * thanks to the struct gs_host_config byte_order member, which is sent first
79  * to indicate the desired byte order.
80  */
81 
82 struct gs_device_config {
83 	u8 reserved1;
84 	u8 reserved2;
85 	u8 reserved3;
86 	u8 icount;
87 	u32 sw_version;
88 	u32 hw_version;
89 } __packed;
90 
91 #define GS_CAN_MODE_NORMAL               0
92 #define GS_CAN_MODE_LISTEN_ONLY          BIT(0)
93 #define GS_CAN_MODE_LOOP_BACK            BIT(1)
94 #define GS_CAN_MODE_TRIPLE_SAMPLE        BIT(2)
95 #define GS_CAN_MODE_ONE_SHOT             BIT(3)
96 
97 struct gs_device_mode {
98 	u32 mode;
99 	u32 flags;
100 } __packed;
101 
102 struct gs_device_state {
103 	u32 state;
104 	u32 rxerr;
105 	u32 txerr;
106 } __packed;
107 
108 struct gs_device_bittiming {
109 	u32 prop_seg;
110 	u32 phase_seg1;
111 	u32 phase_seg2;
112 	u32 sjw;
113 	u32 brp;
114 } __packed;
115 
116 struct gs_identify_mode {
117 	u32 mode;
118 } __packed;
119 
120 #define GS_CAN_FEATURE_LISTEN_ONLY      BIT(0)
121 #define GS_CAN_FEATURE_LOOP_BACK        BIT(1)
122 #define GS_CAN_FEATURE_TRIPLE_SAMPLE    BIT(2)
123 #define GS_CAN_FEATURE_ONE_SHOT         BIT(3)
124 #define GS_CAN_FEATURE_HW_TIMESTAMP     BIT(4)
125 #define GS_CAN_FEATURE_IDENTIFY         BIT(5)
126 
127 struct gs_device_bt_const {
128 	u32 feature;
129 	u32 fclk_can;
130 	u32 tseg1_min;
131 	u32 tseg1_max;
132 	u32 tseg2_min;
133 	u32 tseg2_max;
134 	u32 sjw_max;
135 	u32 brp_min;
136 	u32 brp_max;
137 	u32 brp_inc;
138 } __packed;
139 
140 #define GS_CAN_FLAG_OVERFLOW 1
141 
142 struct gs_host_frame {
143 	u32 echo_id;
144 	u32 can_id;
145 
146 	u8 can_dlc;
147 	u8 channel;
148 	u8 flags;
149 	u8 reserved;
150 
151 	u8 data[8];
152 } __packed;
153 /* The GS USB devices make use of the same flags and masks as in
154  * linux/can.h and linux/can/error.h, and no additional mapping is necessary.
155  */
156 
157 /* Only send a max of GS_MAX_TX_URBS frames per channel at a time. */
158 #define GS_MAX_TX_URBS 10
159 /* Only launch a max of GS_MAX_RX_URBS usb requests at a time. */
160 #define GS_MAX_RX_URBS 30
161 /* Maximum number of interfaces the driver supports per device.
162  * Current hardware only supports 2 interfaces. The future may vary.
163  */
164 #define GS_MAX_INTF 2
165 
166 struct gs_tx_context {
167 	struct gs_can *dev;
168 	unsigned int echo_id;
169 };
170 
171 struct gs_can {
172 	struct can_priv can; /* must be the first member */
173 
174 	struct gs_usb *parent;
175 
176 	struct net_device *netdev;
177 	struct usb_device *udev;
178 	struct usb_interface *iface;
179 
180 	struct can_bittiming_const bt_const;
181 	unsigned int channel;	/* channel number */
182 
183 	/* This lock prevents a race condition between xmit and receive. */
184 	spinlock_t tx_ctx_lock;
185 	struct gs_tx_context tx_context[GS_MAX_TX_URBS];
186 
187 	struct usb_anchor tx_submitted;
188 	atomic_t active_tx_urbs;
189 };
190 
191 /* usb interface struct */
192 struct gs_usb {
193 	struct gs_can *canch[GS_MAX_INTF];
194 	struct usb_anchor rx_submitted;
195 	atomic_t active_channels;
196 	struct usb_device *udev;
197 };
198 
199 /* 'allocate' a tx context.
200  * returns a valid tx context or NULL if there is no space.
201  */
202 static struct gs_tx_context *gs_alloc_tx_context(struct gs_can *dev)
203 {
204 	int i = 0;
205 	unsigned long flags;
206 
207 	spin_lock_irqsave(&dev->tx_ctx_lock, flags);
208 
209 	for (; i < GS_MAX_TX_URBS; i++) {
210 		if (dev->tx_context[i].echo_id == GS_MAX_TX_URBS) {
211 			dev->tx_context[i].echo_id = i;
212 			spin_unlock_irqrestore(&dev->tx_ctx_lock, flags);
213 			return &dev->tx_context[i];
214 		}
215 	}
216 
217 	spin_unlock_irqrestore(&dev->tx_ctx_lock, flags);
218 	return NULL;
219 }
220 
221 /* releases a tx context
222  */
223 static void gs_free_tx_context(struct gs_tx_context *txc)
224 {
225 	txc->echo_id = GS_MAX_TX_URBS;
226 }
227 
228 /* Get a tx context by id.
229  */
230 static struct gs_tx_context *gs_get_tx_context(struct gs_can *dev,
231 					       unsigned int id)
232 {
233 	unsigned long flags;
234 
235 	if (id < GS_MAX_TX_URBS) {
236 		spin_lock_irqsave(&dev->tx_ctx_lock, flags);
237 		if (dev->tx_context[id].echo_id == id) {
238 			spin_unlock_irqrestore(&dev->tx_ctx_lock, flags);
239 			return &dev->tx_context[id];
240 		}
241 		spin_unlock_irqrestore(&dev->tx_ctx_lock, flags);
242 	}
243 	return NULL;
244 }
245 
246 static int gs_cmd_reset(struct gs_usb *gsusb, struct gs_can *gsdev)
247 {
248 	struct gs_device_mode *dm;
249 	struct usb_interface *intf = gsdev->iface;
250 	int rc;
251 
252 	dm = kzalloc(sizeof(*dm), GFP_KERNEL);
253 	if (!dm)
254 		return -ENOMEM;
255 
256 	dm->mode = GS_CAN_MODE_RESET;
257 
258 	rc = usb_control_msg(interface_to_usbdev(intf),
259 			     usb_sndctrlpipe(interface_to_usbdev(intf), 0),
260 			     GS_USB_BREQ_MODE,
261 			     USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
262 			     gsdev->channel,
263 			     0,
264 			     dm,
265 			     sizeof(*dm),
266 			     1000);
267 
268 	return rc;
269 }
270 
271 static void gs_update_state(struct gs_can *dev, struct can_frame *cf)
272 {
273 	struct can_device_stats *can_stats = &dev->can.can_stats;
274 
275 	if (cf->can_id & CAN_ERR_RESTARTED) {
276 		dev->can.state = CAN_STATE_ERROR_ACTIVE;
277 		can_stats->restarts++;
278 	} else if (cf->can_id & CAN_ERR_BUSOFF) {
279 		dev->can.state = CAN_STATE_BUS_OFF;
280 		can_stats->bus_off++;
281 	} else if (cf->can_id & CAN_ERR_CRTL) {
282 		if ((cf->data[1] & CAN_ERR_CRTL_TX_WARNING) ||
283 		    (cf->data[1] & CAN_ERR_CRTL_RX_WARNING)) {
284 			dev->can.state = CAN_STATE_ERROR_WARNING;
285 			can_stats->error_warning++;
286 		} else if ((cf->data[1] & CAN_ERR_CRTL_TX_PASSIVE) ||
287 			   (cf->data[1] & CAN_ERR_CRTL_RX_PASSIVE)) {
288 			dev->can.state = CAN_STATE_ERROR_PASSIVE;
289 			can_stats->error_passive++;
290 		} else {
291 			dev->can.state = CAN_STATE_ERROR_ACTIVE;
292 		}
293 	}
294 }
295 
296 static void gs_usb_receive_bulk_callback(struct urb *urb)
297 {
298 	struct gs_usb *usbcan = urb->context;
299 	struct gs_can *dev;
300 	struct net_device *netdev;
301 	int rc;
302 	struct net_device_stats *stats;
303 	struct gs_host_frame *hf = urb->transfer_buffer;
304 	struct gs_tx_context *txc;
305 	struct can_frame *cf;
306 	struct sk_buff *skb;
307 
308 	BUG_ON(!usbcan);
309 
310 	switch (urb->status) {
311 	case 0: /* success */
312 		break;
313 	case -ENOENT:
314 	case -ESHUTDOWN:
315 		return;
316 	default:
317 		/* do not resubmit aborted urbs. eg: when device goes down */
318 		return;
319 	}
320 
321 	/* device reports out of range channel id */
322 	if (hf->channel >= GS_MAX_INTF)
323 		goto resubmit_urb;
324 
325 	dev = usbcan->canch[hf->channel];
326 
327 	netdev = dev->netdev;
328 	stats = &netdev->stats;
329 
330 	if (!netif_device_present(netdev))
331 		return;
332 
333 	if (hf->echo_id == -1) { /* normal rx */
334 		skb = alloc_can_skb(dev->netdev, &cf);
335 		if (!skb)
336 			return;
337 
338 		cf->can_id = hf->can_id;
339 
340 		cf->can_dlc = get_can_dlc(hf->can_dlc);
341 		memcpy(cf->data, hf->data, 8);
342 
343 		/* ERROR frames tell us information about the controller */
344 		if (hf->can_id & CAN_ERR_FLAG)
345 			gs_update_state(dev, cf);
346 
347 		netdev->stats.rx_packets++;
348 		netdev->stats.rx_bytes += hf->can_dlc;
349 
350 		netif_rx(skb);
351 	} else { /* echo_id == hf->echo_id */
352 		if (hf->echo_id >= GS_MAX_TX_URBS) {
353 			netdev_err(netdev,
354 				   "Unexpected out of range echo id %d\n",
355 				   hf->echo_id);
356 			goto resubmit_urb;
357 		}
358 
359 		netdev->stats.tx_packets++;
360 		netdev->stats.tx_bytes += hf->can_dlc;
361 
362 		txc = gs_get_tx_context(dev, hf->echo_id);
363 
364 		/* bad devices send bad echo_ids. */
365 		if (!txc) {
366 			netdev_err(netdev,
367 				   "Unexpected unused echo id %d\n",
368 				   hf->echo_id);
369 			goto resubmit_urb;
370 		}
371 
372 		can_get_echo_skb(netdev, hf->echo_id);
373 
374 		gs_free_tx_context(txc);
375 
376 		netif_wake_queue(netdev);
377 	}
378 
379 	if (hf->flags & GS_CAN_FLAG_OVERFLOW) {
380 		skb = alloc_can_err_skb(netdev, &cf);
381 		if (!skb)
382 			goto resubmit_urb;
383 
384 		cf->can_id |= CAN_ERR_CRTL;
385 		cf->can_dlc = CAN_ERR_DLC;
386 		cf->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
387 		stats->rx_over_errors++;
388 		stats->rx_errors++;
389 		netif_rx(skb);
390 	}
391 
392  resubmit_urb:
393 	usb_fill_bulk_urb(urb,
394 			  usbcan->udev,
395 			  usb_rcvbulkpipe(usbcan->udev, GSUSB_ENDPOINT_IN),
396 			  hf,
397 			  sizeof(struct gs_host_frame),
398 			  gs_usb_receive_bulk_callback,
399 			  usbcan
400 			  );
401 
402 	rc = usb_submit_urb(urb, GFP_ATOMIC);
403 
404 	/* USB failure take down all interfaces */
405 	if (rc == -ENODEV) {
406 		for (rc = 0; rc < GS_MAX_INTF; rc++) {
407 			if (usbcan->canch[rc])
408 				netif_device_detach(usbcan->canch[rc]->netdev);
409 		}
410 	}
411 }
412 
413 static int gs_usb_set_bittiming(struct net_device *netdev)
414 {
415 	struct gs_can *dev = netdev_priv(netdev);
416 	struct can_bittiming *bt = &dev->can.bittiming;
417 	struct usb_interface *intf = dev->iface;
418 	int rc;
419 	struct gs_device_bittiming *dbt;
420 
421 	dbt = kmalloc(sizeof(*dbt), GFP_KERNEL);
422 	if (!dbt)
423 		return -ENOMEM;
424 
425 	dbt->prop_seg = bt->prop_seg;
426 	dbt->phase_seg1 = bt->phase_seg1;
427 	dbt->phase_seg2 = bt->phase_seg2;
428 	dbt->sjw = bt->sjw;
429 	dbt->brp = bt->brp;
430 
431 	/* request bit timings */
432 	rc = usb_control_msg(interface_to_usbdev(intf),
433 			     usb_sndctrlpipe(interface_to_usbdev(intf), 0),
434 			     GS_USB_BREQ_BITTIMING,
435 			     USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
436 			     dev->channel,
437 			     0,
438 			     dbt,
439 			     sizeof(*dbt),
440 			     1000);
441 
442 	kfree(dbt);
443 
444 	if (rc < 0)
445 		dev_err(netdev->dev.parent, "Couldn't set bittimings (err=%d)",
446 			rc);
447 
448 	return rc;
449 }
450 
451 static void gs_usb_xmit_callback(struct urb *urb)
452 {
453 	struct gs_tx_context *txc = urb->context;
454 	struct gs_can *dev = txc->dev;
455 	struct net_device *netdev = dev->netdev;
456 
457 	if (urb->status)
458 		netdev_info(netdev, "usb xmit fail %d\n", txc->echo_id);
459 
460 	usb_free_coherent(urb->dev,
461 			  urb->transfer_buffer_length,
462 			  urb->transfer_buffer,
463 			  urb->transfer_dma);
464 
465 	atomic_dec(&dev->active_tx_urbs);
466 
467 	if (!netif_device_present(netdev))
468 		return;
469 
470 	if (netif_queue_stopped(netdev))
471 		netif_wake_queue(netdev);
472 }
473 
474 static netdev_tx_t gs_can_start_xmit(struct sk_buff *skb,
475 				     struct net_device *netdev)
476 {
477 	struct gs_can *dev = netdev_priv(netdev);
478 	struct net_device_stats *stats = &dev->netdev->stats;
479 	struct urb *urb;
480 	struct gs_host_frame *hf;
481 	struct can_frame *cf;
482 	int rc;
483 	unsigned int idx;
484 	struct gs_tx_context *txc;
485 
486 	if (can_dropped_invalid_skb(netdev, skb))
487 		return NETDEV_TX_OK;
488 
489 	/* find an empty context to keep track of transmission */
490 	txc = gs_alloc_tx_context(dev);
491 	if (!txc)
492 		return NETDEV_TX_BUSY;
493 
494 	/* create a URB, and a buffer for it */
495 	urb = usb_alloc_urb(0, GFP_ATOMIC);
496 	if (!urb) {
497 		netdev_err(netdev, "No memory left for URB\n");
498 		goto nomem_urb;
499 	}
500 
501 	hf = usb_alloc_coherent(dev->udev, sizeof(*hf), GFP_ATOMIC,
502 				&urb->transfer_dma);
503 	if (!hf) {
504 		netdev_err(netdev, "No memory left for USB buffer\n");
505 		goto nomem_hf;
506 	}
507 
508 	idx = txc->echo_id;
509 
510 	if (idx >= GS_MAX_TX_URBS) {
511 		netdev_err(netdev, "Invalid tx context %d\n", idx);
512 		goto badidx;
513 	}
514 
515 	hf->echo_id = idx;
516 	hf->channel = dev->channel;
517 
518 	cf = (struct can_frame *)skb->data;
519 
520 	hf->can_id = cf->can_id;
521 	hf->can_dlc = cf->can_dlc;
522 	memcpy(hf->data, cf->data, cf->can_dlc);
523 
524 	usb_fill_bulk_urb(urb, dev->udev,
525 			  usb_sndbulkpipe(dev->udev, GSUSB_ENDPOINT_OUT),
526 			  hf,
527 			  sizeof(*hf),
528 			  gs_usb_xmit_callback,
529 			  txc);
530 
531 	urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
532 	usb_anchor_urb(urb, &dev->tx_submitted);
533 
534 	can_put_echo_skb(skb, netdev, idx);
535 
536 	atomic_inc(&dev->active_tx_urbs);
537 
538 	rc = usb_submit_urb(urb, GFP_ATOMIC);
539 	if (unlikely(rc)) {			/* usb send failed */
540 		atomic_dec(&dev->active_tx_urbs);
541 
542 		can_free_echo_skb(netdev, idx);
543 		gs_free_tx_context(txc);
544 
545 		usb_unanchor_urb(urb);
546 		usb_free_coherent(dev->udev,
547 				  sizeof(*hf),
548 				  hf,
549 				  urb->transfer_dma);
550 
551 
552 		if (rc == -ENODEV) {
553 			netif_device_detach(netdev);
554 		} else {
555 			netdev_err(netdev, "usb_submit failed (err=%d)\n", rc);
556 			stats->tx_dropped++;
557 		}
558 	} else {
559 		/* Slow down tx path */
560 		if (atomic_read(&dev->active_tx_urbs) >= GS_MAX_TX_URBS)
561 			netif_stop_queue(netdev);
562 	}
563 
564 	/* let usb core take care of this urb */
565 	usb_free_urb(urb);
566 
567 	return NETDEV_TX_OK;
568 
569  badidx:
570 	usb_free_coherent(dev->udev,
571 			  sizeof(*hf),
572 			  hf,
573 			  urb->transfer_dma);
574  nomem_hf:
575 	usb_free_urb(urb);
576 
577  nomem_urb:
578 	gs_free_tx_context(txc);
579 	dev_kfree_skb(skb);
580 	stats->tx_dropped++;
581 	return NETDEV_TX_OK;
582 }
583 
584 static int gs_can_open(struct net_device *netdev)
585 {
586 	struct gs_can *dev = netdev_priv(netdev);
587 	struct gs_usb *parent = dev->parent;
588 	int rc, i;
589 	struct gs_device_mode *dm;
590 	u32 ctrlmode;
591 
592 	rc = open_candev(netdev);
593 	if (rc)
594 		return rc;
595 
596 	if (atomic_add_return(1, &parent->active_channels) == 1) {
597 		for (i = 0; i < GS_MAX_RX_URBS; i++) {
598 			struct urb *urb;
599 			u8 *buf;
600 
601 			/* alloc rx urb */
602 			urb = usb_alloc_urb(0, GFP_KERNEL);
603 			if (!urb) {
604 				netdev_err(netdev,
605 					   "No memory left for URB\n");
606 				return -ENOMEM;
607 			}
608 
609 			/* alloc rx buffer */
610 			buf = usb_alloc_coherent(dev->udev,
611 						 sizeof(struct gs_host_frame),
612 						 GFP_KERNEL,
613 						 &urb->transfer_dma);
614 			if (!buf) {
615 				netdev_err(netdev,
616 					   "No memory left for USB buffer\n");
617 				usb_free_urb(urb);
618 				return -ENOMEM;
619 			}
620 
621 			/* fill, anchor, and submit rx urb */
622 			usb_fill_bulk_urb(urb,
623 					  dev->udev,
624 					  usb_rcvbulkpipe(dev->udev,
625 							  GSUSB_ENDPOINT_IN),
626 					  buf,
627 					  sizeof(struct gs_host_frame),
628 					  gs_usb_receive_bulk_callback,
629 					  parent);
630 			urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
631 
632 			usb_anchor_urb(urb, &parent->rx_submitted);
633 
634 			rc = usb_submit_urb(urb, GFP_KERNEL);
635 			if (rc) {
636 				if (rc == -ENODEV)
637 					netif_device_detach(dev->netdev);
638 
639 				netdev_err(netdev,
640 					   "usb_submit failed (err=%d)\n",
641 					   rc);
642 
643 				usb_unanchor_urb(urb);
644 				break;
645 			}
646 
647 			/* Drop reference,
648 			 * USB core will take care of freeing it
649 			 */
650 			usb_free_urb(urb);
651 		}
652 	}
653 
654 	dm = kmalloc(sizeof(*dm), GFP_KERNEL);
655 	if (!dm)
656 		return -ENOMEM;
657 
658 	/* flags */
659 	ctrlmode = dev->can.ctrlmode;
660 	dm->flags = 0;
661 
662 	if (ctrlmode & CAN_CTRLMODE_LOOPBACK)
663 		dm->flags |= GS_CAN_MODE_LOOP_BACK;
664 	else if (ctrlmode & CAN_CTRLMODE_LISTENONLY)
665 		dm->flags |= GS_CAN_MODE_LISTEN_ONLY;
666 
667 	/* Controller is not allowed to retry TX
668 	 * this mode is unavailable on atmels uc3c hardware
669 	 */
670 	if (ctrlmode & CAN_CTRLMODE_ONE_SHOT)
671 		dm->flags |= GS_CAN_MODE_ONE_SHOT;
672 
673 	if (ctrlmode & CAN_CTRLMODE_3_SAMPLES)
674 		dm->flags |= GS_CAN_MODE_TRIPLE_SAMPLE;
675 
676 	/* finally start device */
677 	dm->mode = GS_CAN_MODE_START;
678 	rc = usb_control_msg(interface_to_usbdev(dev->iface),
679 			     usb_sndctrlpipe(interface_to_usbdev(dev->iface), 0),
680 			     GS_USB_BREQ_MODE,
681 			     USB_DIR_OUT | USB_TYPE_VENDOR |
682 			     USB_RECIP_INTERFACE,
683 			     dev->channel,
684 			     0,
685 			     dm,
686 			     sizeof(*dm),
687 			     1000);
688 
689 	if (rc < 0) {
690 		netdev_err(netdev, "Couldn't start device (err=%d)\n", rc);
691 		kfree(dm);
692 		return rc;
693 	}
694 
695 	kfree(dm);
696 
697 	dev->can.state = CAN_STATE_ERROR_ACTIVE;
698 
699 	if (!(dev->can.ctrlmode & CAN_CTRLMODE_LISTENONLY))
700 		netif_start_queue(netdev);
701 
702 	return 0;
703 }
704 
705 static int gs_can_close(struct net_device *netdev)
706 {
707 	int rc;
708 	struct gs_can *dev = netdev_priv(netdev);
709 	struct gs_usb *parent = dev->parent;
710 
711 	netif_stop_queue(netdev);
712 
713 	/* Stop polling */
714 	if (atomic_dec_and_test(&parent->active_channels))
715 		usb_kill_anchored_urbs(&parent->rx_submitted);
716 
717 	/* Stop sending URBs */
718 	usb_kill_anchored_urbs(&dev->tx_submitted);
719 	atomic_set(&dev->active_tx_urbs, 0);
720 
721 	/* reset the device */
722 	rc = gs_cmd_reset(parent, dev);
723 	if (rc < 0)
724 		netdev_warn(netdev, "Couldn't shutdown device (err=%d)", rc);
725 
726 	/* reset tx contexts */
727 	for (rc = 0; rc < GS_MAX_TX_URBS; rc++) {
728 		dev->tx_context[rc].dev = dev;
729 		dev->tx_context[rc].echo_id = GS_MAX_TX_URBS;
730 	}
731 
732 	/* close the netdev */
733 	close_candev(netdev);
734 
735 	return 0;
736 }
737 
738 static const struct net_device_ops gs_usb_netdev_ops = {
739 	.ndo_open = gs_can_open,
740 	.ndo_stop = gs_can_close,
741 	.ndo_start_xmit = gs_can_start_xmit,
742 	.ndo_change_mtu = can_change_mtu,
743 };
744 
745 static int gs_usb_set_identify(struct net_device *netdev, bool do_identify)
746 {
747 	struct gs_can *dev = netdev_priv(netdev);
748 	struct gs_identify_mode imode;
749 	int rc;
750 
751 	if (do_identify)
752 		imode.mode = GS_CAN_IDENTIFY_ON;
753 	else
754 		imode.mode = GS_CAN_IDENTIFY_OFF;
755 
756 	rc = usb_control_msg(interface_to_usbdev(dev->iface),
757 			     usb_sndctrlpipe(interface_to_usbdev(dev->iface),
758 					     0),
759 			     GS_USB_BREQ_IDENTIFY,
760 			     USB_DIR_OUT | USB_TYPE_VENDOR |
761 			     USB_RECIP_INTERFACE,
762 			     dev->channel,
763 			     0,
764 			     &imode,
765 			     sizeof(imode),
766 			     100);
767 
768 	return (rc > 0) ? 0 : rc;
769 }
770 
771 /* blink LED's for finding the this interface */
772 static int gs_usb_set_phys_id(struct net_device *dev,
773 			      enum ethtool_phys_id_state state)
774 {
775 	int rc = 0;
776 
777 	switch (state) {
778 	case ETHTOOL_ID_ACTIVE:
779 		rc = gs_usb_set_identify(dev, GS_CAN_IDENTIFY_ON);
780 		break;
781 	case ETHTOOL_ID_INACTIVE:
782 		rc = gs_usb_set_identify(dev, GS_CAN_IDENTIFY_OFF);
783 		break;
784 	default:
785 		break;
786 	}
787 
788 	return rc;
789 }
790 
791 static const struct ethtool_ops gs_usb_ethtool_ops = {
792 	.set_phys_id = gs_usb_set_phys_id,
793 };
794 
795 static struct gs_can *gs_make_candev(unsigned int channel,
796 				     struct usb_interface *intf,
797 				     struct gs_device_config *dconf)
798 {
799 	struct gs_can *dev;
800 	struct net_device *netdev;
801 	int rc;
802 	struct gs_device_bt_const *bt_const;
803 
804 	bt_const = kmalloc(sizeof(*bt_const), GFP_KERNEL);
805 	if (!bt_const)
806 		return ERR_PTR(-ENOMEM);
807 
808 	/* fetch bit timing constants */
809 	rc = usb_control_msg(interface_to_usbdev(intf),
810 			     usb_rcvctrlpipe(interface_to_usbdev(intf), 0),
811 			     GS_USB_BREQ_BT_CONST,
812 			     USB_DIR_IN|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
813 			     channel,
814 			     0,
815 			     bt_const,
816 			     sizeof(*bt_const),
817 			     1000);
818 
819 	if (rc < 0) {
820 		dev_err(&intf->dev,
821 			"Couldn't get bit timing const for channel (err=%d)\n",
822 			rc);
823 		kfree(bt_const);
824 		return ERR_PTR(rc);
825 	}
826 
827 	/* create netdev */
828 	netdev = alloc_candev(sizeof(struct gs_can), GS_MAX_TX_URBS);
829 	if (!netdev) {
830 		dev_err(&intf->dev, "Couldn't allocate candev\n");
831 		kfree(bt_const);
832 		return ERR_PTR(-ENOMEM);
833 	}
834 
835 	dev = netdev_priv(netdev);
836 
837 	netdev->netdev_ops = &gs_usb_netdev_ops;
838 
839 	netdev->flags |= IFF_ECHO; /* we support full roundtrip echo */
840 
841 	/* dev settup */
842 	strcpy(dev->bt_const.name, "gs_usb");
843 	dev->bt_const.tseg1_min = bt_const->tseg1_min;
844 	dev->bt_const.tseg1_max = bt_const->tseg1_max;
845 	dev->bt_const.tseg2_min = bt_const->tseg2_min;
846 	dev->bt_const.tseg2_max = bt_const->tseg2_max;
847 	dev->bt_const.sjw_max = bt_const->sjw_max;
848 	dev->bt_const.brp_min = bt_const->brp_min;
849 	dev->bt_const.brp_max = bt_const->brp_max;
850 	dev->bt_const.brp_inc = bt_const->brp_inc;
851 
852 	dev->udev = interface_to_usbdev(intf);
853 	dev->iface = intf;
854 	dev->netdev = netdev;
855 	dev->channel = channel;
856 
857 	init_usb_anchor(&dev->tx_submitted);
858 	atomic_set(&dev->active_tx_urbs, 0);
859 	spin_lock_init(&dev->tx_ctx_lock);
860 	for (rc = 0; rc < GS_MAX_TX_URBS; rc++) {
861 		dev->tx_context[rc].dev = dev;
862 		dev->tx_context[rc].echo_id = GS_MAX_TX_URBS;
863 	}
864 
865 	/* can settup */
866 	dev->can.state = CAN_STATE_STOPPED;
867 	dev->can.clock.freq = bt_const->fclk_can;
868 	dev->can.bittiming_const = &dev->bt_const;
869 	dev->can.do_set_bittiming = gs_usb_set_bittiming;
870 
871 	dev->can.ctrlmode_supported = 0;
872 
873 	if (bt_const->feature & GS_CAN_FEATURE_LISTEN_ONLY)
874 		dev->can.ctrlmode_supported |= CAN_CTRLMODE_LISTENONLY;
875 
876 	if (bt_const->feature & GS_CAN_FEATURE_LOOP_BACK)
877 		dev->can.ctrlmode_supported |= CAN_CTRLMODE_LOOPBACK;
878 
879 	if (bt_const->feature & GS_CAN_FEATURE_TRIPLE_SAMPLE)
880 		dev->can.ctrlmode_supported |= CAN_CTRLMODE_3_SAMPLES;
881 
882 	if (bt_const->feature & GS_CAN_FEATURE_ONE_SHOT)
883 		dev->can.ctrlmode_supported |= CAN_CTRLMODE_ONE_SHOT;
884 
885 	SET_NETDEV_DEV(netdev, &intf->dev);
886 
887 	if (dconf->sw_version > 1)
888 		if (bt_const->feature & GS_CAN_FEATURE_IDENTIFY)
889 			netdev->ethtool_ops = &gs_usb_ethtool_ops;
890 
891 	kfree(bt_const);
892 
893 	rc = register_candev(dev->netdev);
894 	if (rc) {
895 		free_candev(dev->netdev);
896 		dev_err(&intf->dev, "Couldn't register candev (err=%d)\n", rc);
897 		return ERR_PTR(rc);
898 	}
899 
900 	return dev;
901 }
902 
903 static void gs_destroy_candev(struct gs_can *dev)
904 {
905 	unregister_candev(dev->netdev);
906 	usb_kill_anchored_urbs(&dev->tx_submitted);
907 	free_candev(dev->netdev);
908 }
909 
910 static int gs_usb_probe(struct usb_interface *intf,
911 			const struct usb_device_id *id)
912 {
913 	struct gs_usb *dev;
914 	int rc = -ENOMEM;
915 	unsigned int icount, i;
916 	struct gs_host_config hconf = {
917 		.byte_order = 0x0000beef,
918 	};
919 	struct gs_device_config dconf;
920 
921 	/* send host config */
922 	rc = usb_control_msg(interface_to_usbdev(intf),
923 			     usb_sndctrlpipe(interface_to_usbdev(intf), 0),
924 			     GS_USB_BREQ_HOST_FORMAT,
925 			     USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
926 			     1,
927 			     intf->altsetting[0].desc.bInterfaceNumber,
928 			     &hconf,
929 			     sizeof(hconf),
930 			     1000);
931 
932 	if (rc < 0) {
933 		dev_err(&intf->dev, "Couldn't send data format (err=%d)\n",
934 			rc);
935 		return rc;
936 	}
937 
938 	/* read device config */
939 	rc = usb_control_msg(interface_to_usbdev(intf),
940 			     usb_rcvctrlpipe(interface_to_usbdev(intf), 0),
941 			     GS_USB_BREQ_DEVICE_CONFIG,
942 			     USB_DIR_IN|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
943 			     1,
944 			     intf->altsetting[0].desc.bInterfaceNumber,
945 			     &dconf,
946 			     sizeof(dconf),
947 			     1000);
948 	if (rc < 0) {
949 		dev_err(&intf->dev, "Couldn't get device config: (err=%d)\n",
950 			rc);
951 		return rc;
952 	}
953 
954 	icount = dconf.icount + 1;
955 	dev_info(&intf->dev, "Configuring for %d interfaces\n", icount);
956 
957 	if (icount > GS_MAX_INTF) {
958 		dev_err(&intf->dev,
959 			"Driver cannot handle more that %d CAN interfaces\n",
960 			GS_MAX_INTF);
961 		return -EINVAL;
962 	}
963 
964 	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
965 	if (!dev)
966 		return -ENOMEM;
967 	init_usb_anchor(&dev->rx_submitted);
968 
969 	atomic_set(&dev->active_channels, 0);
970 
971 	usb_set_intfdata(intf, dev);
972 	dev->udev = interface_to_usbdev(intf);
973 
974 	for (i = 0; i < icount; i++) {
975 		dev->canch[i] = gs_make_candev(i, intf, &dconf);
976 		if (IS_ERR_OR_NULL(dev->canch[i])) {
977 			/* save error code to return later */
978 			rc = PTR_ERR(dev->canch[i]);
979 
980 			/* on failure destroy previously created candevs */
981 			icount = i;
982 			for (i = 0; i < icount; i++)
983 				gs_destroy_candev(dev->canch[i]);
984 
985 			usb_kill_anchored_urbs(&dev->rx_submitted);
986 			kfree(dev);
987 			return rc;
988 		}
989 		dev->canch[i]->parent = dev;
990 	}
991 
992 	return 0;
993 }
994 
995 static void gs_usb_disconnect(struct usb_interface *intf)
996 {
997 	unsigned i;
998 	struct gs_usb *dev = usb_get_intfdata(intf);
999 	usb_set_intfdata(intf, NULL);
1000 
1001 	if (!dev) {
1002 		dev_err(&intf->dev, "Disconnect (nodata)\n");
1003 		return;
1004 	}
1005 
1006 	for (i = 0; i < GS_MAX_INTF; i++)
1007 		if (dev->canch[i])
1008 			gs_destroy_candev(dev->canch[i]);
1009 
1010 	usb_kill_anchored_urbs(&dev->rx_submitted);
1011 	kfree(dev);
1012 }
1013 
1014 static const struct usb_device_id gs_usb_table[] = {
1015 	{ USB_DEVICE_INTERFACE_NUMBER(USB_GSUSB_1_VENDOR_ID,
1016 				      USB_GSUSB_1_PRODUCT_ID, 0) },
1017 	{ USB_DEVICE_INTERFACE_NUMBER(USB_CANDLELIGHT_VENDOR_ID,
1018 				      USB_CANDLELIGHT_PRODUCT_ID, 0) },
1019 	{} /* Terminating entry */
1020 };
1021 
1022 MODULE_DEVICE_TABLE(usb, gs_usb_table);
1023 
1024 static struct usb_driver gs_usb_driver = {
1025 	.name       = "gs_usb",
1026 	.probe      = gs_usb_probe,
1027 	.disconnect = gs_usb_disconnect,
1028 	.id_table   = gs_usb_table,
1029 };
1030 
1031 module_usb_driver(gs_usb_driver);
1032 
1033 MODULE_AUTHOR("Maximilian Schneider <mws@schneidersoft.net>");
1034 MODULE_DESCRIPTION(
1035 "Socket CAN device driver for Geschwister Schneider Technologie-, "
1036 "Entwicklungs- und Vertriebs UG. USB2.0 to CAN interfaces\n"
1037 "and bytewerk.org candleLight USB CAN interfaces.");
1038 MODULE_LICENSE("GPL v2");
1039