esd_usb2.c revision fae37f81fdf3680c5d70abdc57e7b83f4b6c266a
1/*
2 * CAN driver for esd CAN-USB/2 and CAN-USB/Micro
3 *
4 * Copyright (C) 2010-2012 Matthias Fuchs <matthias.fuchs@esd.eu>, esd gmbh
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published
8 * by the Free Software Foundation; version 2 of the License.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 * General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19#include <linux/init.h>
20#include <linux/signal.h>
21#include <linux/slab.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
30MODULE_AUTHOR("Matthias Fuchs <matthias.fuchs@esd.eu>");
31MODULE_DESCRIPTION("CAN driver for esd CAN-USB/2 and CAN-USB/Micro interfaces");
32MODULE_LICENSE("GPL v2");
33
34/* Define these values to match your devices */
35#define USB_ESDGMBH_VENDOR_ID	0x0ab4
36#define USB_CANUSB2_PRODUCT_ID	0x0010
37#define USB_CANUSBM_PRODUCT_ID	0x0011
38
39#define ESD_USB2_CAN_CLOCK	60000000
40#define ESD_USBM_CAN_CLOCK	36000000
41#define ESD_USB2_MAX_NETS	2
42
43/* USB2 commands */
44#define CMD_VERSION		1 /* also used for VERSION_REPLY */
45#define CMD_CAN_RX		2 /* device to host only */
46#define CMD_CAN_TX		3 /* also used for TX_DONE */
47#define CMD_SETBAUD		4 /* also used for SETBAUD_REPLY */
48#define CMD_TS			5 /* also used for TS_REPLY */
49#define CMD_IDADD		6 /* also used for IDADD_REPLY */
50
51/* esd CAN message flags - dlc field */
52#define ESD_RTR			0x10
53
54/* esd CAN message flags - id field */
55#define ESD_EXTID		0x20000000
56#define ESD_EVENT		0x40000000
57#define ESD_IDMASK		0x1fffffff
58
59/* esd CAN event ids used by this driver */
60#define ESD_EV_CAN_ERROR_EXT	2
61
62/* baudrate message flags */
63#define ESD_USB2_UBR		0x80000000
64#define ESD_USB2_LOM		0x40000000
65#define ESD_USB2_NO_BAUDRATE	0x7fffffff
66#define ESD_USB2_TSEG1_MIN	1
67#define ESD_USB2_TSEG1_MAX	16
68#define ESD_USB2_TSEG1_SHIFT	16
69#define ESD_USB2_TSEG2_MIN	1
70#define ESD_USB2_TSEG2_MAX	8
71#define ESD_USB2_TSEG2_SHIFT	20
72#define ESD_USB2_SJW_MAX	4
73#define ESD_USB2_SJW_SHIFT	14
74#define ESD_USBM_SJW_SHIFT	24
75#define ESD_USB2_BRP_MIN	1
76#define ESD_USB2_BRP_MAX	1024
77#define ESD_USB2_BRP_INC	1
78#define ESD_USB2_3_SAMPLES	0x00800000
79
80/* esd IDADD message */
81#define ESD_ID_ENABLE		0x80
82#define ESD_MAX_ID_SEGMENT	64
83
84/* SJA1000 ECC register (emulated by usb2 firmware) */
85#define SJA1000_ECC_SEG		0x1F
86#define SJA1000_ECC_DIR		0x20
87#define SJA1000_ECC_ERR		0x06
88#define SJA1000_ECC_BIT		0x00
89#define SJA1000_ECC_FORM	0x40
90#define SJA1000_ECC_STUFF	0x80
91#define SJA1000_ECC_MASK	0xc0
92
93/* esd bus state event codes */
94#define ESD_BUSSTATE_MASK	0xc0
95#define ESD_BUSSTATE_WARN	0x40
96#define ESD_BUSSTATE_ERRPASSIVE	0x80
97#define ESD_BUSSTATE_BUSOFF	0xc0
98
99#define RX_BUFFER_SIZE		1024
100#define MAX_RX_URBS		4
101#define MAX_TX_URBS		16 /* must be power of 2 */
102
103struct header_msg {
104	u8 len; /* len is always the total message length in 32bit words */
105	u8 cmd;
106	u8 rsvd[2];
107};
108
109struct version_msg {
110	u8 len;
111	u8 cmd;
112	u8 rsvd;
113	u8 flags;
114	__le32 drv_version;
115};
116
117struct version_reply_msg {
118	u8 len;
119	u8 cmd;
120	u8 nets;
121	u8 features;
122	__le32 version;
123	u8 name[16];
124	__le32 rsvd;
125	__le32 ts;
126};
127
128struct rx_msg {
129	u8 len;
130	u8 cmd;
131	u8 net;
132	u8 dlc;
133	__le32 ts;
134	__le32 id; /* upper 3 bits contain flags */
135	u8 data[8];
136};
137
138struct tx_msg {
139	u8 len;
140	u8 cmd;
141	u8 net;
142	u8 dlc;
143	__le32 hnd;
144	__le32 id; /* upper 3 bits contain flags */
145	u8 data[8];
146};
147
148struct tx_done_msg {
149	u8 len;
150	u8 cmd;
151	u8 net;
152	u8 status;
153	__le32 hnd;
154	__le32 ts;
155};
156
157struct id_filter_msg {
158	u8 len;
159	u8 cmd;
160	u8 net;
161	u8 option;
162	__le32 mask[ESD_MAX_ID_SEGMENT + 1];
163};
164
165struct set_baudrate_msg {
166	u8 len;
167	u8 cmd;
168	u8 net;
169	u8 rsvd;
170	__le32 baud;
171};
172
173/* Main message type used between library and application */
174struct __attribute__ ((packed)) esd_usb2_msg {
175	union {
176		struct header_msg hdr;
177		struct version_msg version;
178		struct version_reply_msg version_reply;
179		struct rx_msg rx;
180		struct tx_msg tx;
181		struct tx_done_msg txdone;
182		struct set_baudrate_msg setbaud;
183		struct id_filter_msg filter;
184	} msg;
185};
186
187static struct usb_device_id esd_usb2_table[] = {
188	{USB_DEVICE(USB_ESDGMBH_VENDOR_ID, USB_CANUSB2_PRODUCT_ID)},
189	{USB_DEVICE(USB_ESDGMBH_VENDOR_ID, USB_CANUSBM_PRODUCT_ID)},
190	{}
191};
192MODULE_DEVICE_TABLE(usb, esd_usb2_table);
193
194struct esd_usb2_net_priv;
195
196struct esd_tx_urb_context {
197	struct esd_usb2_net_priv *priv;
198	u32 echo_index;
199	int dlc;
200};
201
202struct esd_usb2 {
203	struct usb_device *udev;
204	struct esd_usb2_net_priv *nets[ESD_USB2_MAX_NETS];
205
206	struct usb_anchor rx_submitted;
207
208	int net_count;
209	u32 version;
210	int rxinitdone;
211};
212
213struct esd_usb2_net_priv {
214	struct can_priv can; /* must be the first member */
215
216	atomic_t active_tx_jobs;
217	struct usb_anchor tx_submitted;
218	struct esd_tx_urb_context tx_contexts[MAX_TX_URBS];
219
220	struct esd_usb2 *usb2;
221	struct net_device *netdev;
222	int index;
223	u8 old_state;
224	struct can_berr_counter bec;
225};
226
227static void esd_usb2_rx_event(struct esd_usb2_net_priv *priv,
228			      struct esd_usb2_msg *msg)
229{
230	struct net_device_stats *stats = &priv->netdev->stats;
231	struct can_frame *cf;
232	struct sk_buff *skb;
233	u32 id = le32_to_cpu(msg->msg.rx.id) & ESD_IDMASK;
234
235	if (id == ESD_EV_CAN_ERROR_EXT) {
236		u8 state = msg->msg.rx.data[0];
237		u8 ecc = msg->msg.rx.data[1];
238		u8 txerr = msg->msg.rx.data[2];
239		u8 rxerr = msg->msg.rx.data[3];
240
241		skb = alloc_can_err_skb(priv->netdev, &cf);
242		if (skb == NULL) {
243			stats->rx_dropped++;
244			return;
245		}
246
247		if (state != priv->old_state) {
248			priv->old_state = state;
249
250			switch (state & ESD_BUSSTATE_MASK) {
251			case ESD_BUSSTATE_BUSOFF:
252				priv->can.state = CAN_STATE_BUS_OFF;
253				cf->can_id |= CAN_ERR_BUSOFF;
254				can_bus_off(priv->netdev);
255				break;
256			case ESD_BUSSTATE_WARN:
257				priv->can.state = CAN_STATE_ERROR_WARNING;
258				priv->can.can_stats.error_warning++;
259				break;
260			case ESD_BUSSTATE_ERRPASSIVE:
261				priv->can.state = CAN_STATE_ERROR_PASSIVE;
262				priv->can.can_stats.error_passive++;
263				break;
264			default:
265				priv->can.state = CAN_STATE_ERROR_ACTIVE;
266				break;
267			}
268		} else {
269			priv->can.can_stats.bus_error++;
270			stats->rx_errors++;
271
272			cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
273
274			switch (ecc & SJA1000_ECC_MASK) {
275			case SJA1000_ECC_BIT:
276				cf->data[2] |= CAN_ERR_PROT_BIT;
277				break;
278			case SJA1000_ECC_FORM:
279				cf->data[2] |= CAN_ERR_PROT_FORM;
280				break;
281			case SJA1000_ECC_STUFF:
282				cf->data[2] |= CAN_ERR_PROT_STUFF;
283				break;
284			default:
285				cf->data[2] |= CAN_ERR_PROT_UNSPEC;
286				cf->data[3] = ecc & SJA1000_ECC_SEG;
287				break;
288			}
289
290			/* Error occurred during transmission? */
291			if (!(ecc & SJA1000_ECC_DIR))
292				cf->data[2] |= CAN_ERR_PROT_TX;
293
294			if (priv->can.state == CAN_STATE_ERROR_WARNING ||
295			    priv->can.state == CAN_STATE_ERROR_PASSIVE) {
296				cf->data[1] = (txerr > rxerr) ?
297					CAN_ERR_CRTL_TX_PASSIVE :
298					CAN_ERR_CRTL_RX_PASSIVE;
299			}
300			cf->data[6] = txerr;
301			cf->data[7] = rxerr;
302		}
303
304		netif_rx(skb);
305
306		priv->bec.txerr = txerr;
307		priv->bec.rxerr = rxerr;
308
309		stats->rx_packets++;
310		stats->rx_bytes += cf->can_dlc;
311	}
312}
313
314static void esd_usb2_rx_can_msg(struct esd_usb2_net_priv *priv,
315				struct esd_usb2_msg *msg)
316{
317	struct net_device_stats *stats = &priv->netdev->stats;
318	struct can_frame *cf;
319	struct sk_buff *skb;
320	int i;
321	u32 id;
322
323	if (!netif_device_present(priv->netdev))
324		return;
325
326	id = le32_to_cpu(msg->msg.rx.id);
327
328	if (id & ESD_EVENT) {
329		esd_usb2_rx_event(priv, msg);
330	} else {
331		skb = alloc_can_skb(priv->netdev, &cf);
332		if (skb == NULL) {
333			stats->rx_dropped++;
334			return;
335		}
336
337		cf->can_id = id & ESD_IDMASK;
338		cf->can_dlc = get_can_dlc(msg->msg.rx.dlc);
339
340		if (id & ESD_EXTID)
341			cf->can_id |= CAN_EFF_FLAG;
342
343		if (msg->msg.rx.dlc & ESD_RTR) {
344			cf->can_id |= CAN_RTR_FLAG;
345		} else {
346			for (i = 0; i < cf->can_dlc; i++)
347				cf->data[i] = msg->msg.rx.data[i];
348		}
349
350		netif_rx(skb);
351
352		stats->rx_packets++;
353		stats->rx_bytes += cf->can_dlc;
354	}
355
356	return;
357}
358
359static void esd_usb2_tx_done_msg(struct esd_usb2_net_priv *priv,
360				 struct esd_usb2_msg *msg)
361{
362	struct net_device_stats *stats = &priv->netdev->stats;
363	struct net_device *netdev = priv->netdev;
364	struct esd_tx_urb_context *context;
365
366	if (!netif_device_present(netdev))
367		return;
368
369	context = &priv->tx_contexts[msg->msg.txdone.hnd & (MAX_TX_URBS - 1)];
370
371	if (!msg->msg.txdone.status) {
372		stats->tx_packets++;
373		stats->tx_bytes += context->dlc;
374		can_get_echo_skb(netdev, context->echo_index);
375	} else {
376		stats->tx_errors++;
377		can_free_echo_skb(netdev, context->echo_index);
378	}
379
380	/* Release context */
381	context->echo_index = MAX_TX_URBS;
382	atomic_dec(&priv->active_tx_jobs);
383
384	netif_wake_queue(netdev);
385}
386
387static void esd_usb2_read_bulk_callback(struct urb *urb)
388{
389	struct esd_usb2 *dev = urb->context;
390	int retval;
391	int pos = 0;
392	int i;
393
394	switch (urb->status) {
395	case 0: /* success */
396		break;
397
398	case -ENOENT:
399	case -ESHUTDOWN:
400		return;
401
402	default:
403		dev_info(dev->udev->dev.parent,
404			 "Rx URB aborted (%d)\n", urb->status);
405		goto resubmit_urb;
406	}
407
408	while (pos < urb->actual_length) {
409		struct esd_usb2_msg *msg;
410
411		msg = (struct esd_usb2_msg *)(urb->transfer_buffer + pos);
412
413		switch (msg->msg.hdr.cmd) {
414		case CMD_CAN_RX:
415			esd_usb2_rx_can_msg(dev->nets[msg->msg.rx.net], msg);
416			break;
417
418		case CMD_CAN_TX:
419			esd_usb2_tx_done_msg(dev->nets[msg->msg.txdone.net],
420					     msg);
421			break;
422		}
423
424		pos += msg->msg.hdr.len << 2;
425
426		if (pos > urb->actual_length) {
427			dev_err(dev->udev->dev.parent, "format error\n");
428			break;
429		}
430	}
431
432resubmit_urb:
433	usb_fill_bulk_urb(urb, dev->udev, usb_rcvbulkpipe(dev->udev, 1),
434			  urb->transfer_buffer, RX_BUFFER_SIZE,
435			  esd_usb2_read_bulk_callback, dev);
436
437	retval = usb_submit_urb(urb, GFP_ATOMIC);
438	if (retval == -ENODEV) {
439		for (i = 0; i < dev->net_count; i++) {
440			if (dev->nets[i])
441				netif_device_detach(dev->nets[i]->netdev);
442		}
443	} else if (retval) {
444		dev_err(dev->udev->dev.parent,
445			"failed resubmitting read bulk urb: %d\n", retval);
446	}
447
448	return;
449}
450
451/*
452 * callback for bulk IN urb
453 */
454static void esd_usb2_write_bulk_callback(struct urb *urb)
455{
456	struct esd_tx_urb_context *context = urb->context;
457	struct esd_usb2_net_priv *priv;
458	struct esd_usb2 *dev;
459	struct net_device *netdev;
460	size_t size = sizeof(struct esd_usb2_msg);
461
462	WARN_ON(!context);
463
464	priv = context->priv;
465	netdev = priv->netdev;
466	dev = priv->usb2;
467
468	/* free up our allocated buffer */
469	usb_free_coherent(urb->dev, size,
470			  urb->transfer_buffer, urb->transfer_dma);
471
472	if (!netif_device_present(netdev))
473		return;
474
475	if (urb->status)
476		netdev_info(netdev, "Tx URB aborted (%d)\n", urb->status);
477
478	netdev->trans_start = jiffies;
479}
480
481static ssize_t show_firmware(struct device *d,
482			     struct device_attribute *attr, char *buf)
483{
484	struct usb_interface *intf = to_usb_interface(d);
485	struct esd_usb2 *dev = usb_get_intfdata(intf);
486
487	return sprintf(buf, "%d.%d.%d\n",
488		       (dev->version >> 12) & 0xf,
489		       (dev->version >> 8) & 0xf,
490		       dev->version & 0xff);
491}
492static DEVICE_ATTR(firmware, S_IRUGO, show_firmware, NULL);
493
494static ssize_t show_hardware(struct device *d,
495			     struct device_attribute *attr, char *buf)
496{
497	struct usb_interface *intf = to_usb_interface(d);
498	struct esd_usb2 *dev = usb_get_intfdata(intf);
499
500	return sprintf(buf, "%d.%d.%d\n",
501		       (dev->version >> 28) & 0xf,
502		       (dev->version >> 24) & 0xf,
503		       (dev->version >> 16) & 0xff);
504}
505static DEVICE_ATTR(hardware, S_IRUGO, show_hardware, NULL);
506
507static ssize_t show_nets(struct device *d,
508			 struct device_attribute *attr, char *buf)
509{
510	struct usb_interface *intf = to_usb_interface(d);
511	struct esd_usb2 *dev = usb_get_intfdata(intf);
512
513	return sprintf(buf, "%d", dev->net_count);
514}
515static DEVICE_ATTR(nets, S_IRUGO, show_nets, NULL);
516
517static int esd_usb2_send_msg(struct esd_usb2 *dev, struct esd_usb2_msg *msg)
518{
519	int actual_length;
520
521	return usb_bulk_msg(dev->udev,
522			    usb_sndbulkpipe(dev->udev, 2),
523			    msg,
524			    msg->msg.hdr.len << 2,
525			    &actual_length,
526			    1000);
527}
528
529static int esd_usb2_wait_msg(struct esd_usb2 *dev,
530			     struct esd_usb2_msg *msg)
531{
532	int actual_length;
533
534	return usb_bulk_msg(dev->udev,
535			    usb_rcvbulkpipe(dev->udev, 1),
536			    msg,
537			    sizeof(*msg),
538			    &actual_length,
539			    1000);
540}
541
542static int esd_usb2_setup_rx_urbs(struct esd_usb2 *dev)
543{
544	int i, err = 0;
545
546	if (dev->rxinitdone)
547		return 0;
548
549	for (i = 0; i < MAX_RX_URBS; i++) {
550		struct urb *urb = NULL;
551		u8 *buf = NULL;
552
553		/* create a URB, and a buffer for it */
554		urb = usb_alloc_urb(0, GFP_KERNEL);
555		if (!urb) {
556			dev_warn(dev->udev->dev.parent,
557				 "No memory left for URBs\n");
558			err = -ENOMEM;
559			break;
560		}
561
562		buf = usb_alloc_coherent(dev->udev, RX_BUFFER_SIZE, GFP_KERNEL,
563					 &urb->transfer_dma);
564		if (!buf) {
565			dev_warn(dev->udev->dev.parent,
566				 "No memory left for USB buffer\n");
567			err = -ENOMEM;
568			goto freeurb;
569		}
570
571		usb_fill_bulk_urb(urb, dev->udev,
572				  usb_rcvbulkpipe(dev->udev, 1),
573				  buf, RX_BUFFER_SIZE,
574				  esd_usb2_read_bulk_callback, dev);
575		urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
576		usb_anchor_urb(urb, &dev->rx_submitted);
577
578		err = usb_submit_urb(urb, GFP_KERNEL);
579		if (err) {
580			usb_unanchor_urb(urb);
581			usb_free_coherent(dev->udev, RX_BUFFER_SIZE, buf,
582					  urb->transfer_dma);
583		}
584
585freeurb:
586		/* Drop reference, USB core will take care of freeing it */
587		usb_free_urb(urb);
588		if (err)
589			break;
590	}
591
592	/* Did we submit any URBs */
593	if (i == 0) {
594		dev_err(dev->udev->dev.parent, "couldn't setup read URBs\n");
595		return err;
596	}
597
598	/* Warn if we've couldn't transmit all the URBs */
599	if (i < MAX_RX_URBS) {
600		dev_warn(dev->udev->dev.parent,
601			 "rx performance may be slow\n");
602	}
603
604	dev->rxinitdone = 1;
605	return 0;
606}
607
608/*
609 * Start interface
610 */
611static int esd_usb2_start(struct esd_usb2_net_priv *priv)
612{
613	struct esd_usb2 *dev = priv->usb2;
614	struct net_device *netdev = priv->netdev;
615	struct esd_usb2_msg *msg;
616	int err, i;
617
618	msg = kmalloc(sizeof(*msg), GFP_KERNEL);
619	if (!msg) {
620		err = -ENOMEM;
621		goto out;
622	}
623
624	/*
625	 * Enable all IDs
626	 * The IDADD message takes up to 64 32 bit bitmasks (2048 bits).
627	 * Each bit represents one 11 bit CAN identifier. A set bit
628	 * enables reception of the corresponding CAN identifier. A cleared
629	 * bit disabled this identifier. An additional bitmask value
630	 * following the CAN 2.0A bits is used to enable reception of
631	 * extended CAN frames. Only the LSB of this final mask is checked
632	 * for the complete 29 bit ID range. The IDADD message also allows
633	 * filter configuration for an ID subset. In this case you can add
634	 * the number of the starting bitmask (0..64) to the filter.option
635	 * field followed by only some bitmasks.
636	 */
637	msg->msg.hdr.cmd = CMD_IDADD;
638	msg->msg.hdr.len = 2 + ESD_MAX_ID_SEGMENT;
639	msg->msg.filter.net = priv->index;
640	msg->msg.filter.option = ESD_ID_ENABLE; /* start with segment 0 */
641	for (i = 0; i < ESD_MAX_ID_SEGMENT; i++)
642		msg->msg.filter.mask[i] = cpu_to_le32(0xffffffff);
643	/* enable 29bit extended IDs */
644	msg->msg.filter.mask[ESD_MAX_ID_SEGMENT] = cpu_to_le32(0x00000001);
645
646	err = esd_usb2_send_msg(dev, msg);
647	if (err)
648		goto out;
649
650	err = esd_usb2_setup_rx_urbs(dev);
651	if (err)
652		goto out;
653
654	priv->can.state = CAN_STATE_ERROR_ACTIVE;
655
656out:
657	if (err == -ENODEV)
658		netif_device_detach(netdev);
659	if (err)
660		netdev_err(netdev, "couldn't start device: %d\n", err);
661
662	kfree(msg);
663	return err;
664}
665
666static void unlink_all_urbs(struct esd_usb2 *dev)
667{
668	struct esd_usb2_net_priv *priv;
669	int i, j;
670
671	usb_kill_anchored_urbs(&dev->rx_submitted);
672	for (i = 0; i < dev->net_count; i++) {
673		priv = dev->nets[i];
674		if (priv) {
675			usb_kill_anchored_urbs(&priv->tx_submitted);
676			atomic_set(&priv->active_tx_jobs, 0);
677
678			for (j = 0; j < MAX_TX_URBS; j++)
679				priv->tx_contexts[j].echo_index = MAX_TX_URBS;
680		}
681	}
682}
683
684static int esd_usb2_open(struct net_device *netdev)
685{
686	struct esd_usb2_net_priv *priv = netdev_priv(netdev);
687	int err;
688
689	/* common open */
690	err = open_candev(netdev);
691	if (err)
692		return err;
693
694	/* finally start device */
695	err = esd_usb2_start(priv);
696	if (err) {
697		netdev_warn(netdev, "couldn't start device: %d\n", err);
698		close_candev(netdev);
699		return err;
700	}
701
702	netif_start_queue(netdev);
703
704	return 0;
705}
706
707static netdev_tx_t esd_usb2_start_xmit(struct sk_buff *skb,
708				      struct net_device *netdev)
709{
710	struct esd_usb2_net_priv *priv = netdev_priv(netdev);
711	struct esd_usb2 *dev = priv->usb2;
712	struct esd_tx_urb_context *context = NULL;
713	struct net_device_stats *stats = &netdev->stats;
714	struct can_frame *cf = (struct can_frame *)skb->data;
715	struct esd_usb2_msg *msg;
716	struct urb *urb;
717	u8 *buf;
718	int i, err;
719	int ret = NETDEV_TX_OK;
720	size_t size = sizeof(struct esd_usb2_msg);
721
722	if (can_dropped_invalid_skb(netdev, skb))
723		return NETDEV_TX_OK;
724
725	/* create a URB, and a buffer for it, and copy the data to the URB */
726	urb = usb_alloc_urb(0, GFP_ATOMIC);
727	if (!urb) {
728		netdev_err(netdev, "No memory left for URBs\n");
729		stats->tx_dropped++;
730		dev_kfree_skb(skb);
731		goto nourbmem;
732	}
733
734	buf = usb_alloc_coherent(dev->udev, size, GFP_ATOMIC,
735				 &urb->transfer_dma);
736	if (!buf) {
737		netdev_err(netdev, "No memory left for USB buffer\n");
738		stats->tx_dropped++;
739		dev_kfree_skb(skb);
740		goto nobufmem;
741	}
742
743	msg = (struct esd_usb2_msg *)buf;
744
745	msg->msg.hdr.len = 3; /* minimal length */
746	msg->msg.hdr.cmd = CMD_CAN_TX;
747	msg->msg.tx.net = priv->index;
748	msg->msg.tx.dlc = cf->can_dlc;
749	msg->msg.tx.id = cpu_to_le32(cf->can_id & CAN_ERR_MASK);
750
751	if (cf->can_id & CAN_RTR_FLAG)
752		msg->msg.tx.dlc |= ESD_RTR;
753
754	if (cf->can_id & CAN_EFF_FLAG)
755		msg->msg.tx.id |= cpu_to_le32(ESD_EXTID);
756
757	for (i = 0; i < cf->can_dlc; i++)
758		msg->msg.tx.data[i] = cf->data[i];
759
760	msg->msg.hdr.len += (cf->can_dlc + 3) >> 2;
761
762	for (i = 0; i < MAX_TX_URBS; i++) {
763		if (priv->tx_contexts[i].echo_index == MAX_TX_URBS) {
764			context = &priv->tx_contexts[i];
765			break;
766		}
767	}
768
769	/*
770	 * This may never happen.
771	 */
772	if (!context) {
773		netdev_warn(netdev, "couldn't find free context\n");
774		ret = NETDEV_TX_BUSY;
775		goto releasebuf;
776	}
777
778	context->priv = priv;
779	context->echo_index = i;
780	context->dlc = cf->can_dlc;
781
782	/* hnd must not be 0 - MSB is stripped in txdone handling */
783	msg->msg.tx.hnd = 0x80000000 | i; /* returned in TX done message */
784
785	usb_fill_bulk_urb(urb, dev->udev, usb_sndbulkpipe(dev->udev, 2), buf,
786			  msg->msg.hdr.len << 2,
787			  esd_usb2_write_bulk_callback, context);
788
789	urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
790
791	usb_anchor_urb(urb, &priv->tx_submitted);
792
793	can_put_echo_skb(skb, netdev, context->echo_index);
794
795	atomic_inc(&priv->active_tx_jobs);
796
797	/* Slow down tx path */
798	if (atomic_read(&priv->active_tx_jobs) >= MAX_TX_URBS)
799		netif_stop_queue(netdev);
800
801	err = usb_submit_urb(urb, GFP_ATOMIC);
802	if (err) {
803		can_free_echo_skb(netdev, context->echo_index);
804
805		atomic_dec(&priv->active_tx_jobs);
806		usb_unanchor_urb(urb);
807
808		stats->tx_dropped++;
809
810		if (err == -ENODEV)
811			netif_device_detach(netdev);
812		else
813			netdev_warn(netdev, "failed tx_urb %d\n", err);
814
815		goto releasebuf;
816	}
817
818	netdev->trans_start = jiffies;
819
820	/*
821	 * Release our reference to this URB, the USB core will eventually free
822	 * it entirely.
823	 */
824	usb_free_urb(urb);
825
826	return NETDEV_TX_OK;
827
828releasebuf:
829	usb_free_coherent(dev->udev, size, buf, urb->transfer_dma);
830
831nobufmem:
832	usb_free_urb(urb);
833
834nourbmem:
835	return ret;
836}
837
838static int esd_usb2_close(struct net_device *netdev)
839{
840	struct esd_usb2_net_priv *priv = netdev_priv(netdev);
841	struct esd_usb2_msg *msg;
842	int i;
843
844	msg = kmalloc(sizeof(*msg), GFP_KERNEL);
845	if (!msg)
846		return -ENOMEM;
847
848	/* Disable all IDs (see esd_usb2_start()) */
849	msg->msg.hdr.cmd = CMD_IDADD;
850	msg->msg.hdr.len = 2 + ESD_MAX_ID_SEGMENT;
851	msg->msg.filter.net = priv->index;
852	msg->msg.filter.option = ESD_ID_ENABLE; /* start with segment 0 */
853	for (i = 0; i <= ESD_MAX_ID_SEGMENT; i++)
854		msg->msg.filter.mask[i] = 0;
855	if (esd_usb2_send_msg(priv->usb2, msg) < 0)
856		netdev_err(netdev, "sending idadd message failed\n");
857
858	/* set CAN controller to reset mode */
859	msg->msg.hdr.len = 2;
860	msg->msg.hdr.cmd = CMD_SETBAUD;
861	msg->msg.setbaud.net = priv->index;
862	msg->msg.setbaud.rsvd = 0;
863	msg->msg.setbaud.baud = cpu_to_le32(ESD_USB2_NO_BAUDRATE);
864	if (esd_usb2_send_msg(priv->usb2, msg) < 0)
865		netdev_err(netdev, "sending setbaud message failed\n");
866
867	priv->can.state = CAN_STATE_STOPPED;
868
869	netif_stop_queue(netdev);
870
871	close_candev(netdev);
872
873	kfree(msg);
874
875	return 0;
876}
877
878static const struct net_device_ops esd_usb2_netdev_ops = {
879	.ndo_open = esd_usb2_open,
880	.ndo_stop = esd_usb2_close,
881	.ndo_start_xmit = esd_usb2_start_xmit,
882};
883
884static const struct can_bittiming_const esd_usb2_bittiming_const = {
885	.name = "esd_usb2",
886	.tseg1_min = ESD_USB2_TSEG1_MIN,
887	.tseg1_max = ESD_USB2_TSEG1_MAX,
888	.tseg2_min = ESD_USB2_TSEG2_MIN,
889	.tseg2_max = ESD_USB2_TSEG2_MAX,
890	.sjw_max = ESD_USB2_SJW_MAX,
891	.brp_min = ESD_USB2_BRP_MIN,
892	.brp_max = ESD_USB2_BRP_MAX,
893	.brp_inc = ESD_USB2_BRP_INC,
894};
895
896static int esd_usb2_set_bittiming(struct net_device *netdev)
897{
898	struct esd_usb2_net_priv *priv = netdev_priv(netdev);
899	struct can_bittiming *bt = &priv->can.bittiming;
900	struct esd_usb2_msg *msg;
901	int err;
902	u32 canbtr;
903	int sjw_shift;
904
905	canbtr = ESD_USB2_UBR;
906	if (priv->can.ctrlmode & CAN_CTRLMODE_LISTENONLY)
907		canbtr |= ESD_USB2_LOM;
908
909	canbtr |= (bt->brp - 1) & (ESD_USB2_BRP_MAX - 1);
910
911	if (le16_to_cpu(priv->usb2->udev->descriptor.idProduct) ==
912	    USB_CANUSBM_PRODUCT_ID)
913		sjw_shift = ESD_USBM_SJW_SHIFT;
914	else
915		sjw_shift = ESD_USB2_SJW_SHIFT;
916
917	canbtr |= ((bt->sjw - 1) & (ESD_USB2_SJW_MAX - 1))
918		<< sjw_shift;
919	canbtr |= ((bt->prop_seg + bt->phase_seg1 - 1)
920		   & (ESD_USB2_TSEG1_MAX - 1))
921		<< ESD_USB2_TSEG1_SHIFT;
922	canbtr |= ((bt->phase_seg2 - 1) & (ESD_USB2_TSEG2_MAX - 1))
923		<< ESD_USB2_TSEG2_SHIFT;
924	if (priv->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES)
925		canbtr |= ESD_USB2_3_SAMPLES;
926
927	msg = kmalloc(sizeof(*msg), GFP_KERNEL);
928	if (!msg)
929		return -ENOMEM;
930
931	msg->msg.hdr.len = 2;
932	msg->msg.hdr.cmd = CMD_SETBAUD;
933	msg->msg.setbaud.net = priv->index;
934	msg->msg.setbaud.rsvd = 0;
935	msg->msg.setbaud.baud = cpu_to_le32(canbtr);
936
937	netdev_info(netdev, "setting BTR=%#x\n", canbtr);
938
939	err = esd_usb2_send_msg(priv->usb2, msg);
940
941	kfree(msg);
942	return err;
943}
944
945static int esd_usb2_get_berr_counter(const struct net_device *netdev,
946				     struct can_berr_counter *bec)
947{
948	struct esd_usb2_net_priv *priv = netdev_priv(netdev);
949
950	bec->txerr = priv->bec.txerr;
951	bec->rxerr = priv->bec.rxerr;
952
953	return 0;
954}
955
956static int esd_usb2_set_mode(struct net_device *netdev, enum can_mode mode)
957{
958	switch (mode) {
959	case CAN_MODE_START:
960		netif_wake_queue(netdev);
961		break;
962
963	default:
964		return -EOPNOTSUPP;
965	}
966
967	return 0;
968}
969
970static int esd_usb2_probe_one_net(struct usb_interface *intf, int index)
971{
972	struct esd_usb2 *dev = usb_get_intfdata(intf);
973	struct net_device *netdev;
974	struct esd_usb2_net_priv *priv;
975	int err = 0;
976	int i;
977
978	netdev = alloc_candev(sizeof(*priv), MAX_TX_URBS);
979	if (!netdev) {
980		dev_err(&intf->dev, "couldn't alloc candev\n");
981		err = -ENOMEM;
982		goto done;
983	}
984
985	priv = netdev_priv(netdev);
986
987	init_usb_anchor(&priv->tx_submitted);
988	atomic_set(&priv->active_tx_jobs, 0);
989
990	for (i = 0; i < MAX_TX_URBS; i++)
991		priv->tx_contexts[i].echo_index = MAX_TX_URBS;
992
993	priv->usb2 = dev;
994	priv->netdev = netdev;
995	priv->index = index;
996
997	priv->can.state = CAN_STATE_STOPPED;
998	priv->can.ctrlmode_supported = CAN_CTRLMODE_LISTENONLY;
999
1000	if (le16_to_cpu(dev->udev->descriptor.idProduct) ==
1001	    USB_CANUSBM_PRODUCT_ID)
1002		priv->can.clock.freq = ESD_USBM_CAN_CLOCK;
1003	else {
1004		priv->can.clock.freq = ESD_USB2_CAN_CLOCK;
1005		priv->can.ctrlmode_supported |= CAN_CTRLMODE_3_SAMPLES;
1006	}
1007
1008	priv->can.bittiming_const = &esd_usb2_bittiming_const;
1009	priv->can.do_set_bittiming = esd_usb2_set_bittiming;
1010	priv->can.do_set_mode = esd_usb2_set_mode;
1011	priv->can.do_get_berr_counter = esd_usb2_get_berr_counter;
1012
1013	netdev->flags |= IFF_ECHO; /* we support local echo */
1014
1015	netdev->netdev_ops = &esd_usb2_netdev_ops;
1016
1017	SET_NETDEV_DEV(netdev, &intf->dev);
1018
1019	err = register_candev(netdev);
1020	if (err) {
1021		dev_err(&intf->dev, "couldn't register CAN device: %d\n", err);
1022		free_candev(netdev);
1023		err = -ENOMEM;
1024		goto done;
1025	}
1026
1027	dev->nets[index] = priv;
1028	netdev_info(netdev, "device %s registered\n", netdev->name);
1029
1030done:
1031	return err;
1032}
1033
1034/*
1035 * probe function for new USB2 devices
1036 *
1037 * check version information and number of available
1038 * CAN interfaces
1039 */
1040static int esd_usb2_probe(struct usb_interface *intf,
1041			 const struct usb_device_id *id)
1042{
1043	struct esd_usb2 *dev;
1044	struct esd_usb2_msg *msg;
1045	int i, err;
1046
1047	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1048	if (!dev) {
1049		err = -ENOMEM;
1050		goto done;
1051	}
1052
1053	dev->udev = interface_to_usbdev(intf);
1054
1055	init_usb_anchor(&dev->rx_submitted);
1056
1057	usb_set_intfdata(intf, dev);
1058
1059	msg = kmalloc(sizeof(*msg), GFP_KERNEL);
1060	if (!msg) {
1061		err = -ENOMEM;
1062		goto free_msg;
1063	}
1064
1065	/* query number of CAN interfaces (nets) */
1066	msg->msg.hdr.cmd = CMD_VERSION;
1067	msg->msg.hdr.len = 2;
1068	msg->msg.version.rsvd = 0;
1069	msg->msg.version.flags = 0;
1070	msg->msg.version.drv_version = 0;
1071
1072	err = esd_usb2_send_msg(dev, msg);
1073	if (err < 0) {
1074		dev_err(&intf->dev, "sending version message failed\n");
1075		goto free_msg;
1076	}
1077
1078	err = esd_usb2_wait_msg(dev, msg);
1079	if (err < 0) {
1080		dev_err(&intf->dev, "no version message answer\n");
1081		goto free_msg;
1082	}
1083
1084	dev->net_count = (int)msg->msg.version_reply.nets;
1085	dev->version = le32_to_cpu(msg->msg.version_reply.version);
1086
1087	if (device_create_file(&intf->dev, &dev_attr_firmware))
1088		dev_err(&intf->dev,
1089			"Couldn't create device file for firmware\n");
1090
1091	if (device_create_file(&intf->dev, &dev_attr_hardware))
1092		dev_err(&intf->dev,
1093			"Couldn't create device file for hardware\n");
1094
1095	if (device_create_file(&intf->dev, &dev_attr_nets))
1096		dev_err(&intf->dev,
1097			"Couldn't create device file for nets\n");
1098
1099	/* do per device probing */
1100	for (i = 0; i < dev->net_count; i++)
1101		esd_usb2_probe_one_net(intf, i);
1102
1103free_msg:
1104	kfree(msg);
1105	if (err)
1106		kfree(dev);
1107done:
1108	return err;
1109}
1110
1111/*
1112 * called by the usb core when the device is removed from the system
1113 */
1114static void esd_usb2_disconnect(struct usb_interface *intf)
1115{
1116	struct esd_usb2 *dev = usb_get_intfdata(intf);
1117	struct net_device *netdev;
1118	int i;
1119
1120	device_remove_file(&intf->dev, &dev_attr_firmware);
1121	device_remove_file(&intf->dev, &dev_attr_hardware);
1122	device_remove_file(&intf->dev, &dev_attr_nets);
1123
1124	usb_set_intfdata(intf, NULL);
1125
1126	if (dev) {
1127		for (i = 0; i < dev->net_count; i++) {
1128			if (dev->nets[i]) {
1129				netdev = dev->nets[i]->netdev;
1130				unregister_netdev(netdev);
1131				free_candev(netdev);
1132			}
1133		}
1134		unlink_all_urbs(dev);
1135	}
1136}
1137
1138/* usb specific object needed to register this driver with the usb subsystem */
1139static struct usb_driver esd_usb2_driver = {
1140	.name = "esd_usb2",
1141	.probe = esd_usb2_probe,
1142	.disconnect = esd_usb2_disconnect,
1143	.id_table = esd_usb2_table,
1144};
1145
1146module_usb_driver(esd_usb2_driver);
1147