drivers/net/can/usb/gs_usb.c

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