1 // SPDX-License-Identifier: GPL-2.0-only
3 * CAN driver for PEAK System PCAN-USB FD / PCAN-USB Pro FD adapter
5 * Copyright (C) 2013-2014 Stephane Grosjean <s.grosjean@peak-system.com>
7 #include <linux/netdevice.h>
9 #include <linux/module.h>
11 #include <linux/can.h>
12 #include <linux/can/dev.h>
13 #include <linux/can/error.h>
14 #include <linux/can/dev/peak_canfd.h>
16 #include "pcan_usb_core.h"
17 #include "pcan_usb_pro.h"
19 MODULE_SUPPORTED_DEVICE("PEAK-System PCAN-USB FD adapter");
20 MODULE_SUPPORTED_DEVICE("PEAK-System PCAN-USB Pro FD adapter");
22 #define PCAN_USBPROFD_CHANNEL_COUNT 2
23 #define PCAN_USBFD_CHANNEL_COUNT 1
25 /* PCAN-USB Pro FD adapter internal clock (Hz) */
26 #define PCAN_UFD_CRYSTAL_HZ 80000000
28 #define PCAN_UFD_CMD_BUFFER_SIZE 512
29 #define PCAN_UFD_LOSPD_PKT_SIZE 64
31 /* PCAN-USB Pro FD command timeout (ms.) */
32 #define PCAN_UFD_CMD_TIMEOUT_MS 1000
34 /* PCAN-USB Pro FD rx/tx buffers size */
35 #define PCAN_UFD_RX_BUFFER_SIZE 2048
36 #define PCAN_UFD_TX_BUFFER_SIZE 512
38 /* read some versions info from the hw device */
39 struct __packed pcan_ufd_fw_info {
40 __le16 size_of; /* sizeof this */
41 __le16 type; /* type of this structure */
42 u8 hw_type; /* Type of hardware (HW_TYPE_xxx) */
43 u8 bl_version[3]; /* Bootloader version */
44 u8 hw_version; /* Hardware version (PCB) */
45 u8 fw_version[3]; /* Firmware version */
46 __le32 dev_id[2]; /* "device id" per CAN */
47 __le32 ser_no; /* S/N */
48 __le32 flags; /* special functions */
51 /* handle device specific info used by the netdevices */
52 struct pcan_usb_fd_if {
53 struct peak_usb_device *dev[PCAN_USB_MAX_CHANNEL];
54 struct pcan_ufd_fw_info fw_info;
55 struct peak_time_ref time_ref;
60 /* device information */
61 struct pcan_usb_fd_device {
62 struct peak_usb_device dev;
63 struct can_berr_counter bec;
64 struct pcan_usb_fd_if *usb_if;
68 /* Extended USB commands (non uCAN commands) */
70 /* Clock Modes command */
71 #define PCAN_UFD_CMD_CLK_SET 0x80
73 #define PCAN_UFD_CLK_80MHZ 0x0
74 #define PCAN_UFD_CLK_60MHZ 0x1
75 #define PCAN_UFD_CLK_40MHZ 0x2
76 #define PCAN_UFD_CLK_30MHZ 0x3
77 #define PCAN_UFD_CLK_24MHZ 0x4
78 #define PCAN_UFD_CLK_20MHZ 0x5
79 #define PCAN_UFD_CLK_DEF PCAN_UFD_CLK_80MHZ
81 struct __packed pcan_ufd_clock {
82 __le16 opcode_channel;
88 /* LED control command */
89 #define PCAN_UFD_CMD_LED_SET 0x86
91 #define PCAN_UFD_LED_DEV 0x00
92 #define PCAN_UFD_LED_FAST 0x01
93 #define PCAN_UFD_LED_SLOW 0x02
94 #define PCAN_UFD_LED_ON 0x03
95 #define PCAN_UFD_LED_OFF 0x04
96 #define PCAN_UFD_LED_DEF PCAN_UFD_LED_DEV
98 struct __packed pcan_ufd_led {
99 __le16 opcode_channel;
105 /* Extended usage of uCAN commands CMD_xxx_xx_OPTION for PCAN-USB Pro FD */
106 #define PCAN_UFD_FLTEXT_CALIBRATION 0x8000
108 struct __packed pcan_ufd_options {
109 __le16 opcode_channel;
116 /* Extended usage of uCAN messages for PCAN-USB Pro FD */
117 #define PCAN_UFD_MSG_CALIBRATION 0x100
119 struct __packed pcan_ufd_ts_msg {
124 __le16 usb_frame_index;
128 #define PCAN_UFD_MSG_OVERRUN 0x101
130 #define PCAN_UFD_OVMSG_CHANNEL(o) ((o)->channel & 0xf)
132 struct __packed pcan_ufd_ovr_msg {
141 static inline int pufd_omsg_get_channel(struct pcan_ufd_ovr_msg *om)
143 return om->channel & 0xf;
146 /* Clock mode frequency values */
147 static const u32 pcan_usb_fd_clk_freq[6] = {
148 [PCAN_UFD_CLK_80MHZ] = 80000000,
149 [PCAN_UFD_CLK_60MHZ] = 60000000,
150 [PCAN_UFD_CLK_40MHZ] = 40000000,
151 [PCAN_UFD_CLK_30MHZ] = 30000000,
152 [PCAN_UFD_CLK_24MHZ] = 24000000,
153 [PCAN_UFD_CLK_20MHZ] = 20000000
156 /* return a device USB interface */
158 struct pcan_usb_fd_if *pcan_usb_fd_dev_if(struct peak_usb_device *dev)
160 struct pcan_usb_fd_device *pdev =
161 container_of(dev, struct pcan_usb_fd_device, dev);
165 /* return a device USB commands buffer */
166 static inline void *pcan_usb_fd_cmd_buffer(struct peak_usb_device *dev)
168 struct pcan_usb_fd_device *pdev =
169 container_of(dev, struct pcan_usb_fd_device, dev);
170 return pdev->cmd_buffer_addr;
173 /* send PCAN-USB Pro FD commands synchronously */
174 static int pcan_usb_fd_send_cmd(struct peak_usb_device *dev, void *cmd_tail)
176 void *cmd_head = pcan_usb_fd_cmd_buffer(dev);
182 /* usb device unregistered? */
183 if (!(dev->state & PCAN_USB_STATE_CONNECTED))
186 /* if a packet is not filled completely by commands, the command list
187 * is terminated with an "end of collection" record.
189 cmd_len = cmd_tail - cmd_head;
190 if (cmd_len <= (PCAN_UFD_CMD_BUFFER_SIZE - sizeof(u64))) {
191 memset(cmd_tail, 0xff, sizeof(u64));
192 cmd_len += sizeof(u64);
195 packet_ptr = cmd_head;
196 packet_len = cmd_len;
198 /* firmware is not able to re-assemble 512 bytes buffer in full-speed */
199 if (unlikely(dev->udev->speed != USB_SPEED_HIGH))
200 packet_len = min(packet_len, PCAN_UFD_LOSPD_PKT_SIZE);
203 err = usb_bulk_msg(dev->udev,
204 usb_sndbulkpipe(dev->udev,
205 PCAN_USBPRO_EP_CMDOUT),
206 packet_ptr, packet_len,
207 NULL, PCAN_UFD_CMD_TIMEOUT_MS);
209 netdev_err(dev->netdev,
210 "sending command failure: %d\n", err);
214 packet_ptr += packet_len;
215 cmd_len -= packet_len;
217 if (cmd_len < PCAN_UFD_LOSPD_PKT_SIZE)
218 packet_len = cmd_len;
220 } while (packet_len > 0);
225 /* build the commands list in the given buffer, to enter operational mode */
226 static int pcan_usb_fd_build_restart_cmd(struct peak_usb_device *dev, u8 *buf)
228 struct pucan_wr_err_cnt *prc;
229 struct pucan_command *cmd;
232 /* 1st, reset error counters: */
233 prc = (struct pucan_wr_err_cnt *)pc;
234 prc->opcode_channel = pucan_cmd_opcode_channel(dev->ctrl_idx,
235 PUCAN_CMD_WR_ERR_CNT);
237 /* select both counters */
238 prc->sel_mask = cpu_to_le16(PUCAN_WRERRCNT_TE|PUCAN_WRERRCNT_RE);
240 /* and reset their values */
244 /* moves the pointer forward */
245 pc += sizeof(struct pucan_wr_err_cnt);
247 /* add command to switch from ISO to non-ISO mode, if fw allows it */
248 if (dev->can.ctrlmode_supported & CAN_CTRLMODE_FD_NON_ISO) {
249 struct pucan_options *puo = (struct pucan_options *)pc;
251 puo->opcode_channel =
252 (dev->can.ctrlmode & CAN_CTRLMODE_FD_NON_ISO) ?
253 pucan_cmd_opcode_channel(dev->ctrl_idx,
254 PUCAN_CMD_CLR_DIS_OPTION) :
255 pucan_cmd_opcode_channel(dev->ctrl_idx,
256 PUCAN_CMD_SET_EN_OPTION);
258 puo->options = cpu_to_le16(PUCAN_OPTION_CANDFDISO);
260 /* to be sure that no other extended bits will be taken into
265 /* moves the pointer forward */
266 pc += sizeof(struct pucan_options);
269 /* next, go back to operational mode */
270 cmd = (struct pucan_command *)pc;
271 cmd->opcode_channel = pucan_cmd_opcode_channel(dev->ctrl_idx,
272 (dev->can.ctrlmode & CAN_CTRLMODE_LISTENONLY) ?
273 PUCAN_CMD_LISTEN_ONLY_MODE :
274 PUCAN_CMD_NORMAL_MODE);
275 pc += sizeof(struct pucan_command);
280 /* set CAN bus on/off */
281 static int pcan_usb_fd_set_bus(struct peak_usb_device *dev, u8 onoff)
283 u8 *pc = pcan_usb_fd_cmd_buffer(dev);
287 /* build the cmds list to enter operational mode */
288 l = pcan_usb_fd_build_restart_cmd(dev, pc);
290 struct pucan_command *cmd = (struct pucan_command *)pc;
292 /* build cmd to go back to reset mode */
293 cmd->opcode_channel = pucan_cmd_opcode_channel(dev->ctrl_idx,
294 PUCAN_CMD_RESET_MODE);
295 l = sizeof(struct pucan_command);
298 /* send the command */
299 return pcan_usb_fd_send_cmd(dev, pc + l);
302 /* set filtering masks:
304 * idx in range [0..63] selects a row #idx, all rows otherwise
305 * mask in range [0..0xffffffff] defines up to 32 CANIDs in the row(s)
307 * Each bit of this 64 x 32 bits array defines a CANID value:
309 * bit[i,j] = 1 implies that CANID=(i x 32)+j will be received, while
310 * bit[i,j] = 0 implies that CANID=(i x 32)+j will be discarded.
312 static int pcan_usb_fd_set_filter_std(struct peak_usb_device *dev, int idx,
315 struct pucan_filter_std *cmd = pcan_usb_fd_cmd_buffer(dev);
318 /* select all rows when idx is out of range [0..63] */
319 if ((idx < 0) || (idx >= (1 << PUCAN_FLTSTD_ROW_IDX_BITS))) {
320 n = 1 << PUCAN_FLTSTD_ROW_IDX_BITS;
323 /* select the row (and only the row) otherwise */
328 for (i = idx; i < n; i++, cmd++) {
329 cmd->opcode_channel = pucan_cmd_opcode_channel(dev->ctrl_idx,
330 PUCAN_CMD_FILTER_STD);
331 cmd->idx = cpu_to_le16(i);
332 cmd->mask = cpu_to_le32(mask);
335 /* send the command */
336 return pcan_usb_fd_send_cmd(dev, cmd);
341 * onoff set(1)/unset(0) options
342 * mask each bit defines a kind of options to set/unset
344 static int pcan_usb_fd_set_options(struct peak_usb_device *dev,
345 bool onoff, u16 ucan_mask, u16 usb_mask)
347 struct pcan_ufd_options *cmd = pcan_usb_fd_cmd_buffer(dev);
349 cmd->opcode_channel = pucan_cmd_opcode_channel(dev->ctrl_idx,
350 (onoff) ? PUCAN_CMD_SET_EN_OPTION :
351 PUCAN_CMD_CLR_DIS_OPTION);
353 cmd->ucan_mask = cpu_to_le16(ucan_mask);
354 cmd->usb_mask = cpu_to_le16(usb_mask);
356 /* send the command */
357 return pcan_usb_fd_send_cmd(dev, ++cmd);
360 /* setup LED control */
361 static int pcan_usb_fd_set_can_led(struct peak_usb_device *dev, u8 led_mode)
363 struct pcan_ufd_led *cmd = pcan_usb_fd_cmd_buffer(dev);
365 cmd->opcode_channel = pucan_cmd_opcode_channel(dev->ctrl_idx,
366 PCAN_UFD_CMD_LED_SET);
367 cmd->mode = led_mode;
369 /* send the command */
370 return pcan_usb_fd_send_cmd(dev, ++cmd);
373 /* set CAN clock domain */
374 static int pcan_usb_fd_set_clock_domain(struct peak_usb_device *dev,
377 struct pcan_ufd_clock *cmd = pcan_usb_fd_cmd_buffer(dev);
379 cmd->opcode_channel = pucan_cmd_opcode_channel(dev->ctrl_idx,
380 PCAN_UFD_CMD_CLK_SET);
381 cmd->mode = clk_mode;
383 /* send the command */
384 return pcan_usb_fd_send_cmd(dev, ++cmd);
387 /* set bittiming for CAN and CAN-FD header */
388 static int pcan_usb_fd_set_bittiming_slow(struct peak_usb_device *dev,
389 struct can_bittiming *bt)
391 struct pucan_timing_slow *cmd = pcan_usb_fd_cmd_buffer(dev);
393 cmd->opcode_channel = pucan_cmd_opcode_channel(dev->ctrl_idx,
394 PUCAN_CMD_TIMING_SLOW);
395 cmd->sjw_t = PUCAN_TSLOW_SJW_T(bt->sjw - 1,
396 dev->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES);
398 cmd->tseg2 = PUCAN_TSLOW_TSEG2(bt->phase_seg2 - 1);
399 cmd->tseg1 = PUCAN_TSLOW_TSEG1(bt->prop_seg + bt->phase_seg1 - 1);
400 cmd->brp = cpu_to_le16(PUCAN_TSLOW_BRP(bt->brp - 1));
402 cmd->ewl = 96; /* default */
404 /* send the command */
405 return pcan_usb_fd_send_cmd(dev, ++cmd);
408 /* set CAN-FD bittiming for data */
409 static int pcan_usb_fd_set_bittiming_fast(struct peak_usb_device *dev,
410 struct can_bittiming *bt)
412 struct pucan_timing_fast *cmd = pcan_usb_fd_cmd_buffer(dev);
414 cmd->opcode_channel = pucan_cmd_opcode_channel(dev->ctrl_idx,
415 PUCAN_CMD_TIMING_FAST);
416 cmd->sjw = PUCAN_TFAST_SJW(bt->sjw - 1);
417 cmd->tseg2 = PUCAN_TFAST_TSEG2(bt->phase_seg2 - 1);
418 cmd->tseg1 = PUCAN_TFAST_TSEG1(bt->prop_seg + bt->phase_seg1 - 1);
419 cmd->brp = cpu_to_le16(PUCAN_TFAST_BRP(bt->brp - 1));
421 /* send the command */
422 return pcan_usb_fd_send_cmd(dev, ++cmd);
425 /* handle restart but in asynchronously way
426 * (uses PCAN-USB Pro code to complete asynchronous request)
428 static int pcan_usb_fd_restart_async(struct peak_usb_device *dev,
429 struct urb *urb, u8 *buf)
433 /* build the entire cmds list in the provided buffer, to go back into
436 pc += pcan_usb_fd_build_restart_cmd(dev, pc);
439 memset(pc, 0xff, sizeof(struct pucan_command));
440 pc += sizeof(struct pucan_command);
442 /* complete the URB */
443 usb_fill_bulk_urb(urb, dev->udev,
444 usb_sndbulkpipe(dev->udev, PCAN_USBPRO_EP_CMDOUT),
446 pcan_usb_pro_restart_complete, dev);
449 return usb_submit_urb(urb, GFP_ATOMIC);
452 static int pcan_usb_fd_drv_loaded(struct peak_usb_device *dev, bool loaded)
454 struct pcan_usb_fd_device *pdev =
455 container_of(dev, struct pcan_usb_fd_device, dev);
457 pdev->cmd_buffer_addr[0] = 0;
458 pdev->cmd_buffer_addr[1] = !!loaded;
460 return pcan_usb_pro_send_req(dev,
462 PCAN_USBPRO_FCT_DRVLD,
463 pdev->cmd_buffer_addr,
464 PCAN_USBPRO_FCT_DRVLD_REQ_LEN);
467 static int pcan_usb_fd_decode_canmsg(struct pcan_usb_fd_if *usb_if,
468 struct pucan_msg *rx_msg)
470 struct pucan_rx_msg *rm = (struct pucan_rx_msg *)rx_msg;
471 struct peak_usb_device *dev;
472 struct net_device *netdev;
473 struct canfd_frame *cfd;
475 const u16 rx_msg_flags = le16_to_cpu(rm->flags);
477 if (pucan_msg_get_channel(rm) >= ARRAY_SIZE(usb_if->dev))
480 dev = usb_if->dev[pucan_msg_get_channel(rm)];
481 netdev = dev->netdev;
483 if (rx_msg_flags & PUCAN_MSG_EXT_DATA_LEN) {
484 /* CANFD frame case */
485 skb = alloc_canfd_skb(netdev, &cfd);
489 if (rx_msg_flags & PUCAN_MSG_BITRATE_SWITCH)
490 cfd->flags |= CANFD_BRS;
492 if (rx_msg_flags & PUCAN_MSG_ERROR_STATE_IND)
493 cfd->flags |= CANFD_ESI;
495 cfd->len = can_dlc2len(get_canfd_dlc(pucan_msg_get_dlc(rm)));
497 /* CAN 2.0 frame case */
498 skb = alloc_can_skb(netdev, (struct can_frame **)&cfd);
502 cfd->len = get_can_dlc(pucan_msg_get_dlc(rm));
505 cfd->can_id = le32_to_cpu(rm->can_id);
507 if (rx_msg_flags & PUCAN_MSG_EXT_ID)
508 cfd->can_id |= CAN_EFF_FLAG;
510 if (rx_msg_flags & PUCAN_MSG_RTR)
511 cfd->can_id |= CAN_RTR_FLAG;
513 memcpy(cfd->data, rm->d, cfd->len);
515 peak_usb_netif_rx(skb, &usb_if->time_ref, le32_to_cpu(rm->ts_low));
517 netdev->stats.rx_packets++;
518 netdev->stats.rx_bytes += cfd->len;
523 /* handle uCAN status message */
524 static int pcan_usb_fd_decode_status(struct pcan_usb_fd_if *usb_if,
525 struct pucan_msg *rx_msg)
527 struct pucan_status_msg *sm = (struct pucan_status_msg *)rx_msg;
528 struct pcan_usb_fd_device *pdev;
529 enum can_state new_state = CAN_STATE_ERROR_ACTIVE;
530 enum can_state rx_state, tx_state;
531 struct peak_usb_device *dev;
532 struct net_device *netdev;
533 struct can_frame *cf;
536 if (pucan_stmsg_get_channel(sm) >= ARRAY_SIZE(usb_if->dev))
539 dev = usb_if->dev[pucan_stmsg_get_channel(sm)];
540 pdev = container_of(dev, struct pcan_usb_fd_device, dev);
541 netdev = dev->netdev;
543 /* nothing should be sent while in BUS_OFF state */
544 if (dev->can.state == CAN_STATE_BUS_OFF)
547 if (sm->channel_p_w_b & PUCAN_BUS_BUSOFF) {
548 new_state = CAN_STATE_BUS_OFF;
549 } else if (sm->channel_p_w_b & PUCAN_BUS_PASSIVE) {
550 new_state = CAN_STATE_ERROR_PASSIVE;
551 } else if (sm->channel_p_w_b & PUCAN_BUS_WARNING) {
552 new_state = CAN_STATE_ERROR_WARNING;
554 /* no error bit (so, no error skb, back to active state) */
555 dev->can.state = CAN_STATE_ERROR_ACTIVE;
561 /* state hasn't changed */
562 if (new_state == dev->can.state)
565 /* handle bus state change */
566 tx_state = (pdev->bec.txerr >= pdev->bec.rxerr) ? new_state : 0;
567 rx_state = (pdev->bec.txerr <= pdev->bec.rxerr) ? new_state : 0;
569 /* allocate an skb to store the error frame */
570 skb = alloc_can_err_skb(netdev, &cf);
572 can_change_state(netdev, cf, tx_state, rx_state);
574 /* things must be done even in case of OOM */
575 if (new_state == CAN_STATE_BUS_OFF)
581 peak_usb_netif_rx(skb, &usb_if->time_ref, le32_to_cpu(sm->ts_low));
583 netdev->stats.rx_packets++;
584 netdev->stats.rx_bytes += cf->can_dlc;
589 /* handle uCAN error message */
590 static int pcan_usb_fd_decode_error(struct pcan_usb_fd_if *usb_if,
591 struct pucan_msg *rx_msg)
593 struct pucan_error_msg *er = (struct pucan_error_msg *)rx_msg;
594 struct pcan_usb_fd_device *pdev;
595 struct peak_usb_device *dev;
597 if (pucan_ermsg_get_channel(er) >= ARRAY_SIZE(usb_if->dev))
600 dev = usb_if->dev[pucan_ermsg_get_channel(er)];
601 pdev = container_of(dev, struct pcan_usb_fd_device, dev);
603 /* keep a trace of tx and rx error counters for later use */
604 pdev->bec.txerr = er->tx_err_cnt;
605 pdev->bec.rxerr = er->rx_err_cnt;
610 /* handle uCAN overrun message */
611 static int pcan_usb_fd_decode_overrun(struct pcan_usb_fd_if *usb_if,
612 struct pucan_msg *rx_msg)
614 struct pcan_ufd_ovr_msg *ov = (struct pcan_ufd_ovr_msg *)rx_msg;
615 struct peak_usb_device *dev;
616 struct net_device *netdev;
617 struct can_frame *cf;
620 if (pufd_omsg_get_channel(ov) >= ARRAY_SIZE(usb_if->dev))
623 dev = usb_if->dev[pufd_omsg_get_channel(ov)];
624 netdev = dev->netdev;
626 /* allocate an skb to store the error frame */
627 skb = alloc_can_err_skb(netdev, &cf);
631 cf->can_id |= CAN_ERR_CRTL;
632 cf->data[1] |= CAN_ERR_CRTL_RX_OVERFLOW;
634 peak_usb_netif_rx(skb, &usb_if->time_ref, le32_to_cpu(ov->ts_low));
636 netdev->stats.rx_over_errors++;
637 netdev->stats.rx_errors++;
642 /* handle USB calibration message */
643 static void pcan_usb_fd_decode_ts(struct pcan_usb_fd_if *usb_if,
644 struct pucan_msg *rx_msg)
646 struct pcan_ufd_ts_msg *ts = (struct pcan_ufd_ts_msg *)rx_msg;
648 /* should wait until clock is stabilized */
649 if (usb_if->cm_ignore_count > 0)
650 usb_if->cm_ignore_count--;
652 peak_usb_set_ts_now(&usb_if->time_ref, le32_to_cpu(ts->ts_low));
655 /* callback for bulk IN urb */
656 static int pcan_usb_fd_decode_buf(struct peak_usb_device *dev, struct urb *urb)
658 struct pcan_usb_fd_if *usb_if = pcan_usb_fd_dev_if(dev);
659 struct net_device *netdev = dev->netdev;
660 struct pucan_msg *rx_msg;
661 u8 *msg_ptr, *msg_end;
664 /* loop reading all the records from the incoming message */
665 msg_ptr = urb->transfer_buffer;
666 msg_end = urb->transfer_buffer + urb->actual_length;
667 for (; msg_ptr < msg_end;) {
668 u16 rx_msg_type, rx_msg_size;
670 rx_msg = (struct pucan_msg *)msg_ptr;
672 /* null packet found: end of list */
676 rx_msg_size = le16_to_cpu(rx_msg->size);
677 rx_msg_type = le16_to_cpu(rx_msg->type);
679 /* check if the record goes out of current packet */
680 if (msg_ptr + rx_msg_size > msg_end) {
682 "got frag rec: should inc usb rx buf sze\n");
687 switch (rx_msg_type) {
688 case PUCAN_MSG_CAN_RX:
689 err = pcan_usb_fd_decode_canmsg(usb_if, rx_msg);
694 case PCAN_UFD_MSG_CALIBRATION:
695 pcan_usb_fd_decode_ts(usb_if, rx_msg);
698 case PUCAN_MSG_ERROR:
699 err = pcan_usb_fd_decode_error(usb_if, rx_msg);
704 case PUCAN_MSG_STATUS:
705 err = pcan_usb_fd_decode_status(usb_if, rx_msg);
710 case PCAN_UFD_MSG_OVERRUN:
711 err = pcan_usb_fd_decode_overrun(usb_if, rx_msg);
718 "unhandled msg type 0x%02x (%d): ignored\n",
719 rx_msg_type, rx_msg_type);
723 msg_ptr += rx_msg_size;
728 pcan_dump_mem("received msg",
729 urb->transfer_buffer, urb->actual_length);
733 /* CAN/CANFD frames encoding callback */
734 static int pcan_usb_fd_encode_msg(struct peak_usb_device *dev,
735 struct sk_buff *skb, u8 *obuf, size_t *size)
737 struct pucan_tx_msg *tx_msg = (struct pucan_tx_msg *)obuf;
738 struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
739 u16 tx_msg_size, tx_msg_flags;
742 if (cfd->len > CANFD_MAX_DLEN)
745 tx_msg_size = ALIGN(sizeof(struct pucan_tx_msg) + cfd->len, 4);
746 tx_msg->size = cpu_to_le16(tx_msg_size);
747 tx_msg->type = cpu_to_le16(PUCAN_MSG_CAN_TX);
750 if (cfd->can_id & CAN_EFF_FLAG) {
751 tx_msg_flags |= PUCAN_MSG_EXT_ID;
752 tx_msg->can_id = cpu_to_le32(cfd->can_id & CAN_EFF_MASK);
754 tx_msg->can_id = cpu_to_le32(cfd->can_id & CAN_SFF_MASK);
757 if (can_is_canfd_skb(skb)) {
758 /* considering a CANFD frame */
759 can_dlc = can_len2dlc(cfd->len);
761 tx_msg_flags |= PUCAN_MSG_EXT_DATA_LEN;
763 if (cfd->flags & CANFD_BRS)
764 tx_msg_flags |= PUCAN_MSG_BITRATE_SWITCH;
766 if (cfd->flags & CANFD_ESI)
767 tx_msg_flags |= PUCAN_MSG_ERROR_STATE_IND;
769 /* CAND 2.0 frames */
772 if (cfd->can_id & CAN_RTR_FLAG)
773 tx_msg_flags |= PUCAN_MSG_RTR;
776 tx_msg->flags = cpu_to_le16(tx_msg_flags);
777 tx_msg->channel_dlc = PUCAN_MSG_CHANNEL_DLC(dev->ctrl_idx, can_dlc);
778 memcpy(tx_msg->d, cfd->data, cfd->len);
780 /* add null size message to tag the end (messages are 32-bits aligned)
782 tx_msg = (struct pucan_tx_msg *)(obuf + tx_msg_size);
786 /* set the whole size of the USB packet to send */
787 *size = tx_msg_size + sizeof(u32);
792 /* start the interface (last chance before set bus on) */
793 static int pcan_usb_fd_start(struct peak_usb_device *dev)
795 struct pcan_usb_fd_device *pdev =
796 container_of(dev, struct pcan_usb_fd_device, dev);
799 /* set filter mode: all acceptance */
800 err = pcan_usb_fd_set_filter_std(dev, -1, 0xffffffff);
804 /* opening first device: */
805 if (pdev->usb_if->dev_opened_count == 0) {
807 peak_usb_init_time_ref(&pdev->usb_if->time_ref,
810 /* enable USB calibration messages */
811 err = pcan_usb_fd_set_options(dev, 1,
813 PCAN_UFD_FLTEXT_CALIBRATION);
816 pdev->usb_if->dev_opened_count++;
818 /* reset cached error counters */
825 /* socket callback used to copy berr counters values received through USB */
826 static int pcan_usb_fd_get_berr_counter(const struct net_device *netdev,
827 struct can_berr_counter *bec)
829 struct peak_usb_device *dev = netdev_priv(netdev);
830 struct pcan_usb_fd_device *pdev =
831 container_of(dev, struct pcan_usb_fd_device, dev);
839 /* stop interface (last chance before set bus off) */
840 static int pcan_usb_fd_stop(struct peak_usb_device *dev)
842 struct pcan_usb_fd_device *pdev =
843 container_of(dev, struct pcan_usb_fd_device, dev);
845 /* turn off special msgs for that interface if no other dev opened */
846 if (pdev->usb_if->dev_opened_count == 1)
847 pcan_usb_fd_set_options(dev, 0,
849 PCAN_UFD_FLTEXT_CALIBRATION);
850 pdev->usb_if->dev_opened_count--;
855 /* called when probing, to initialize a device object */
856 static int pcan_usb_fd_init(struct peak_usb_device *dev)
858 struct pcan_usb_fd_device *pdev =
859 container_of(dev, struct pcan_usb_fd_device, dev);
860 int i, err = -ENOMEM;
862 /* do this for 1st channel only */
863 if (!dev->prev_siblings) {
864 /* allocate netdevices common structure attached to first one */
865 pdev->usb_if = kzalloc(sizeof(*pdev->usb_if), GFP_KERNEL);
869 /* allocate command buffer once for all for the interface */
870 pdev->cmd_buffer_addr = kzalloc(PCAN_UFD_CMD_BUFFER_SIZE,
872 if (!pdev->cmd_buffer_addr)
875 /* number of ts msgs to ignore before taking one into account */
876 pdev->usb_if->cm_ignore_count = 5;
878 err = pcan_usb_pro_send_req(dev, PCAN_USBPRO_REQ_INFO,
880 &pdev->usb_if->fw_info,
881 sizeof(pdev->usb_if->fw_info));
883 dev_err(dev->netdev->dev.parent,
884 "unable to read %s firmware info (err %d)\n",
885 dev->adapter->name, err);
889 /* explicit use of dev_xxx() instead of netdev_xxx() here:
890 * information displayed are related to the device itself, not
891 * to the canx (channel) device.
893 dev_info(dev->netdev->dev.parent,
894 "PEAK-System %s v%u fw v%u.%u.%u (%u channels)\n",
895 dev->adapter->name, pdev->usb_if->fw_info.hw_version,
896 pdev->usb_if->fw_info.fw_version[0],
897 pdev->usb_if->fw_info.fw_version[1],
898 pdev->usb_if->fw_info.fw_version[2],
899 dev->adapter->ctrl_count);
901 /* check for ability to switch between ISO/non-ISO modes */
902 if (pdev->usb_if->fw_info.fw_version[0] >= 2) {
903 /* firmware >= 2.x supports ISO/non-ISO switching */
904 dev->can.ctrlmode_supported |= CAN_CTRLMODE_FD_NON_ISO;
906 /* firmware < 2.x only supports fixed(!) non-ISO */
907 dev->can.ctrlmode |= CAN_CTRLMODE_FD_NON_ISO;
910 /* tell the hardware the can driver is running */
911 err = pcan_usb_fd_drv_loaded(dev, 1);
913 dev_err(dev->netdev->dev.parent,
914 "unable to tell %s driver is loaded (err %d)\n",
915 dev->adapter->name, err);
919 /* otherwise, simply copy previous sibling's values */
920 struct pcan_usb_fd_device *ppdev =
921 container_of(dev->prev_siblings,
922 struct pcan_usb_fd_device, dev);
924 pdev->usb_if = ppdev->usb_if;
925 pdev->cmd_buffer_addr = ppdev->cmd_buffer_addr;
927 /* do a copy of the ctrlmode[_supported] too */
928 dev->can.ctrlmode = ppdev->dev.can.ctrlmode;
929 dev->can.ctrlmode_supported = ppdev->dev.can.ctrlmode_supported;
932 pdev->usb_if->dev[dev->ctrl_idx] = dev;
934 le32_to_cpu(pdev->usb_if->fw_info.dev_id[dev->ctrl_idx]);
936 /* set clock domain */
937 for (i = 0; i < ARRAY_SIZE(pcan_usb_fd_clk_freq); i++)
938 if (dev->adapter->clock.freq == pcan_usb_fd_clk_freq[i])
941 if (i >= ARRAY_SIZE(pcan_usb_fd_clk_freq)) {
942 dev_warn(dev->netdev->dev.parent,
943 "incompatible clock frequencies\n");
948 pcan_usb_fd_set_clock_domain(dev, i);
950 /* set LED in default state (end of init phase) */
951 pcan_usb_fd_set_can_led(dev, PCAN_UFD_LED_DEF);
956 kfree(pdev->cmd_buffer_addr);
963 /* called when driver module is being unloaded */
964 static void pcan_usb_fd_exit(struct peak_usb_device *dev)
966 struct pcan_usb_fd_device *pdev =
967 container_of(dev, struct pcan_usb_fd_device, dev);
969 /* when rmmod called before unplug and if down, should reset things
972 if (dev->can.state != CAN_STATE_STOPPED) {
973 /* set bus off on the corresponding channel */
974 pcan_usb_fd_set_bus(dev, 0);
977 /* switch off corresponding CAN LEDs */
978 pcan_usb_fd_set_can_led(dev, PCAN_UFD_LED_OFF);
980 /* if channel #0 (only) */
981 if (dev->ctrl_idx == 0) {
982 /* turn off calibration message if any device were opened */
983 if (pdev->usb_if->dev_opened_count > 0)
984 pcan_usb_fd_set_options(dev, 0,
986 PCAN_UFD_FLTEXT_CALIBRATION);
988 /* tell USB adapter that the driver is being unloaded */
989 pcan_usb_fd_drv_loaded(dev, 0);
993 /* called when the USB adapter is unplugged */
994 static void pcan_usb_fd_free(struct peak_usb_device *dev)
996 /* last device: can free shared objects now */
997 if (!dev->prev_siblings && !dev->next_siblings) {
998 struct pcan_usb_fd_device *pdev =
999 container_of(dev, struct pcan_usb_fd_device, dev);
1001 /* free commands buffer */
1002 kfree(pdev->cmd_buffer_addr);
1004 /* free usb interface object */
1005 kfree(pdev->usb_if);
1009 /* describes the PCAN-USB FD adapter */
1010 static const struct can_bittiming_const pcan_usb_fd_const = {
1011 .name = "pcan_usb_fd",
1013 .tseg1_max = (1 << PUCAN_TSLOW_TSGEG1_BITS),
1015 .tseg2_max = (1 << PUCAN_TSLOW_TSGEG2_BITS),
1016 .sjw_max = (1 << PUCAN_TSLOW_SJW_BITS),
1018 .brp_max = (1 << PUCAN_TSLOW_BRP_BITS),
1022 static const struct can_bittiming_const pcan_usb_fd_data_const = {
1023 .name = "pcan_usb_fd",
1025 .tseg1_max = (1 << PUCAN_TFAST_TSGEG1_BITS),
1027 .tseg2_max = (1 << PUCAN_TFAST_TSGEG2_BITS),
1028 .sjw_max = (1 << PUCAN_TFAST_SJW_BITS),
1030 .brp_max = (1 << PUCAN_TFAST_BRP_BITS),
1034 const struct peak_usb_adapter pcan_usb_fd = {
1035 .name = "PCAN-USB FD",
1036 .device_id = PCAN_USBFD_PRODUCT_ID,
1037 .ctrl_count = PCAN_USBFD_CHANNEL_COUNT,
1038 .ctrlmode_supported = CAN_CTRLMODE_FD |
1039 CAN_CTRLMODE_3_SAMPLES | CAN_CTRLMODE_LISTENONLY,
1041 .freq = PCAN_UFD_CRYSTAL_HZ,
1043 .bittiming_const = &pcan_usb_fd_const,
1044 .data_bittiming_const = &pcan_usb_fd_data_const,
1046 /* size of device private data */
1047 .sizeof_dev_private = sizeof(struct pcan_usb_fd_device),
1049 /* timestamps usage */
1051 .ts_period = 1000000, /* calibration period in ts. */
1052 .us_per_ts_scale = 1, /* us = (ts * scale) >> shift */
1053 .us_per_ts_shift = 0,
1055 /* give here messages in/out endpoints */
1056 .ep_msg_in = PCAN_USBPRO_EP_MSGIN,
1057 .ep_msg_out = {PCAN_USBPRO_EP_MSGOUT_0},
1059 /* size of rx/tx usb buffers */
1060 .rx_buffer_size = PCAN_UFD_RX_BUFFER_SIZE,
1061 .tx_buffer_size = PCAN_UFD_TX_BUFFER_SIZE,
1063 /* device callbacks */
1064 .intf_probe = pcan_usb_pro_probe, /* same as PCAN-USB Pro */
1065 .dev_init = pcan_usb_fd_init,
1067 .dev_exit = pcan_usb_fd_exit,
1068 .dev_free = pcan_usb_fd_free,
1069 .dev_set_bus = pcan_usb_fd_set_bus,
1070 .dev_set_bittiming = pcan_usb_fd_set_bittiming_slow,
1071 .dev_set_data_bittiming = pcan_usb_fd_set_bittiming_fast,
1072 .dev_decode_buf = pcan_usb_fd_decode_buf,
1073 .dev_start = pcan_usb_fd_start,
1074 .dev_stop = pcan_usb_fd_stop,
1075 .dev_restart_async = pcan_usb_fd_restart_async,
1076 .dev_encode_msg = pcan_usb_fd_encode_msg,
1078 .do_get_berr_counter = pcan_usb_fd_get_berr_counter,
1081 /* describes the PCAN-CHIP USB */
1082 static const struct can_bittiming_const pcan_usb_chip_const = {
1083 .name = "pcan_chip_usb",
1085 .tseg1_max = (1 << PUCAN_TSLOW_TSGEG1_BITS),
1087 .tseg2_max = (1 << PUCAN_TSLOW_TSGEG2_BITS),
1088 .sjw_max = (1 << PUCAN_TSLOW_SJW_BITS),
1090 .brp_max = (1 << PUCAN_TSLOW_BRP_BITS),
1094 static const struct can_bittiming_const pcan_usb_chip_data_const = {
1095 .name = "pcan_chip_usb",
1097 .tseg1_max = (1 << PUCAN_TFAST_TSGEG1_BITS),
1099 .tseg2_max = (1 << PUCAN_TFAST_TSGEG2_BITS),
1100 .sjw_max = (1 << PUCAN_TFAST_SJW_BITS),
1102 .brp_max = (1 << PUCAN_TFAST_BRP_BITS),
1106 const struct peak_usb_adapter pcan_usb_chip = {
1107 .name = "PCAN-Chip USB",
1108 .device_id = PCAN_USBCHIP_PRODUCT_ID,
1109 .ctrl_count = PCAN_USBFD_CHANNEL_COUNT,
1110 .ctrlmode_supported = CAN_CTRLMODE_FD |
1111 CAN_CTRLMODE_3_SAMPLES | CAN_CTRLMODE_LISTENONLY,
1113 .freq = PCAN_UFD_CRYSTAL_HZ,
1115 .bittiming_const = &pcan_usb_chip_const,
1116 .data_bittiming_const = &pcan_usb_chip_data_const,
1118 /* size of device private data */
1119 .sizeof_dev_private = sizeof(struct pcan_usb_fd_device),
1121 /* timestamps usage */
1123 .ts_period = 1000000, /* calibration period in ts. */
1124 .us_per_ts_scale = 1, /* us = (ts * scale) >> shift */
1125 .us_per_ts_shift = 0,
1127 /* give here messages in/out endpoints */
1128 .ep_msg_in = PCAN_USBPRO_EP_MSGIN,
1129 .ep_msg_out = {PCAN_USBPRO_EP_MSGOUT_0},
1131 /* size of rx/tx usb buffers */
1132 .rx_buffer_size = PCAN_UFD_RX_BUFFER_SIZE,
1133 .tx_buffer_size = PCAN_UFD_TX_BUFFER_SIZE,
1135 /* device callbacks */
1136 .intf_probe = pcan_usb_pro_probe, /* same as PCAN-USB Pro */
1137 .dev_init = pcan_usb_fd_init,
1139 .dev_exit = pcan_usb_fd_exit,
1140 .dev_free = pcan_usb_fd_free,
1141 .dev_set_bus = pcan_usb_fd_set_bus,
1142 .dev_set_bittiming = pcan_usb_fd_set_bittiming_slow,
1143 .dev_set_data_bittiming = pcan_usb_fd_set_bittiming_fast,
1144 .dev_decode_buf = pcan_usb_fd_decode_buf,
1145 .dev_start = pcan_usb_fd_start,
1146 .dev_stop = pcan_usb_fd_stop,
1147 .dev_restart_async = pcan_usb_fd_restart_async,
1148 .dev_encode_msg = pcan_usb_fd_encode_msg,
1150 .do_get_berr_counter = pcan_usb_fd_get_berr_counter,
1153 /* describes the PCAN-USB Pro FD adapter */
1154 static const struct can_bittiming_const pcan_usb_pro_fd_const = {
1155 .name = "pcan_usb_pro_fd",
1157 .tseg1_max = (1 << PUCAN_TSLOW_TSGEG1_BITS),
1159 .tseg2_max = (1 << PUCAN_TSLOW_TSGEG2_BITS),
1160 .sjw_max = (1 << PUCAN_TSLOW_SJW_BITS),
1162 .brp_max = (1 << PUCAN_TSLOW_BRP_BITS),
1166 static const struct can_bittiming_const pcan_usb_pro_fd_data_const = {
1167 .name = "pcan_usb_pro_fd",
1169 .tseg1_max = (1 << PUCAN_TFAST_TSGEG1_BITS),
1171 .tseg2_max = (1 << PUCAN_TFAST_TSGEG2_BITS),
1172 .sjw_max = (1 << PUCAN_TFAST_SJW_BITS),
1174 .brp_max = (1 << PUCAN_TFAST_BRP_BITS),
1178 const struct peak_usb_adapter pcan_usb_pro_fd = {
1179 .name = "PCAN-USB Pro FD",
1180 .device_id = PCAN_USBPROFD_PRODUCT_ID,
1181 .ctrl_count = PCAN_USBPROFD_CHANNEL_COUNT,
1182 .ctrlmode_supported = CAN_CTRLMODE_FD |
1183 CAN_CTRLMODE_3_SAMPLES | CAN_CTRLMODE_LISTENONLY,
1185 .freq = PCAN_UFD_CRYSTAL_HZ,
1187 .bittiming_const = &pcan_usb_pro_fd_const,
1188 .data_bittiming_const = &pcan_usb_pro_fd_data_const,
1190 /* size of device private data */
1191 .sizeof_dev_private = sizeof(struct pcan_usb_fd_device),
1193 /* timestamps usage */
1195 .ts_period = 1000000, /* calibration period in ts. */
1196 .us_per_ts_scale = 1, /* us = (ts * scale) >> shift */
1197 .us_per_ts_shift = 0,
1199 /* give here messages in/out endpoints */
1200 .ep_msg_in = PCAN_USBPRO_EP_MSGIN,
1201 .ep_msg_out = {PCAN_USBPRO_EP_MSGOUT_0, PCAN_USBPRO_EP_MSGOUT_1},
1203 /* size of rx/tx usb buffers */
1204 .rx_buffer_size = PCAN_UFD_RX_BUFFER_SIZE,
1205 .tx_buffer_size = PCAN_UFD_TX_BUFFER_SIZE,
1207 /* device callbacks */
1208 .intf_probe = pcan_usb_pro_probe, /* same as PCAN-USB Pro */
1209 .dev_init = pcan_usb_fd_init,
1211 .dev_exit = pcan_usb_fd_exit,
1212 .dev_free = pcan_usb_fd_free,
1213 .dev_set_bus = pcan_usb_fd_set_bus,
1214 .dev_set_bittiming = pcan_usb_fd_set_bittiming_slow,
1215 .dev_set_data_bittiming = pcan_usb_fd_set_bittiming_fast,
1216 .dev_decode_buf = pcan_usb_fd_decode_buf,
1217 .dev_start = pcan_usb_fd_start,
1218 .dev_stop = pcan_usb_fd_stop,
1219 .dev_restart_async = pcan_usb_fd_restart_async,
1220 .dev_encode_msg = pcan_usb_fd_encode_msg,
1222 .do_get_berr_counter = pcan_usb_fd_get_berr_counter,
1225 /* describes the PCAN-USB X6 adapter */
1226 static const struct can_bittiming_const pcan_usb_x6_const = {
1227 .name = "pcan_usb_x6",
1229 .tseg1_max = (1 << PUCAN_TSLOW_TSGEG1_BITS),
1231 .tseg2_max = (1 << PUCAN_TSLOW_TSGEG2_BITS),
1232 .sjw_max = (1 << PUCAN_TSLOW_SJW_BITS),
1234 .brp_max = (1 << PUCAN_TSLOW_BRP_BITS),
1238 static const struct can_bittiming_const pcan_usb_x6_data_const = {
1239 .name = "pcan_usb_x6",
1241 .tseg1_max = (1 << PUCAN_TFAST_TSGEG1_BITS),
1243 .tseg2_max = (1 << PUCAN_TFAST_TSGEG2_BITS),
1244 .sjw_max = (1 << PUCAN_TFAST_SJW_BITS),
1246 .brp_max = (1 << PUCAN_TFAST_BRP_BITS),
1250 const struct peak_usb_adapter pcan_usb_x6 = {
1251 .name = "PCAN-USB X6",
1252 .device_id = PCAN_USBX6_PRODUCT_ID,
1253 .ctrl_count = PCAN_USBPROFD_CHANNEL_COUNT,
1254 .ctrlmode_supported = CAN_CTRLMODE_FD |
1255 CAN_CTRLMODE_3_SAMPLES | CAN_CTRLMODE_LISTENONLY,
1257 .freq = PCAN_UFD_CRYSTAL_HZ,
1259 .bittiming_const = &pcan_usb_x6_const,
1260 .data_bittiming_const = &pcan_usb_x6_data_const,
1262 /* size of device private data */
1263 .sizeof_dev_private = sizeof(struct pcan_usb_fd_device),
1265 /* timestamps usage */
1267 .ts_period = 1000000, /* calibration period in ts. */
1268 .us_per_ts_scale = 1, /* us = (ts * scale) >> shift */
1269 .us_per_ts_shift = 0,
1271 /* give here messages in/out endpoints */
1272 .ep_msg_in = PCAN_USBPRO_EP_MSGIN,
1273 .ep_msg_out = {PCAN_USBPRO_EP_MSGOUT_0, PCAN_USBPRO_EP_MSGOUT_1},
1275 /* size of rx/tx usb buffers */
1276 .rx_buffer_size = PCAN_UFD_RX_BUFFER_SIZE,
1277 .tx_buffer_size = PCAN_UFD_TX_BUFFER_SIZE,
1279 /* device callbacks */
1280 .intf_probe = pcan_usb_pro_probe, /* same as PCAN-USB Pro */
1281 .dev_init = pcan_usb_fd_init,
1283 .dev_exit = pcan_usb_fd_exit,
1284 .dev_free = pcan_usb_fd_free,
1285 .dev_set_bus = pcan_usb_fd_set_bus,
1286 .dev_set_bittiming = pcan_usb_fd_set_bittiming_slow,
1287 .dev_set_data_bittiming = pcan_usb_fd_set_bittiming_fast,
1288 .dev_decode_buf = pcan_usb_fd_decode_buf,
1289 .dev_start = pcan_usb_fd_start,
1290 .dev_stop = pcan_usb_fd_stop,
1291 .dev_restart_async = pcan_usb_fd_restart_async,
1292 .dev_encode_msg = pcan_usb_fd_encode_msg,
1294 .do_get_berr_counter = pcan_usb_fd_get_berr_counter,