net/can/bcm.c

   1 /*
   2  * bcm.c - Broadcast Manager to filter/send (cyclic) CAN content
   3  *
   4  * Copyright (c) 2002-2017 Volkswagen Group Electronic Research
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of Volkswagen nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * Alternatively, provided that this notice is retained in full, this
  20  * software may be distributed under the terms of the GNU General
  21  * Public License ("GPL") version 2, in which case the provisions of the
  22  * GPL apply INSTEAD OF those given above.
  23  *
  24  * The provided data structures and external interfaces from this code
  25  * are not restricted to be used by modules with a GPL compatible license.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  30  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  31  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  32  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  33  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  34  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  35  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  36  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  37  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  38  * DAMAGE.
  39  *
  40  */
  41
  42 #include <linux/module.h>
  43 #include <linux/init.h>
  44 #include <linux/interrupt.h>
  45 #include <linux/hrtimer.h>
  46 #include <linux/list.h>
  47 #include <linux/proc_fs.h>
  48 #include <linux/seq_file.h>
  49 #include <linux/uio.h>
  50 #include <linux/net.h>
  51 #include <linux/netdevice.h>
  52 #include <linux/socket.h>
  53 #include <linux/if_arp.h>
  54 #include <linux/skbuff.h>
  55 #include <linux/can.h>
  56 #include <linux/can/core.h>
  57 #include <linux/can/skb.h>
  58 #include <linux/can/bcm.h>
  59 #include <linux/slab.h>
  60 #include <net/sock.h>
  61 #include <net/net_namespace.h>
  62
  63 /*
  64  * To send multiple CAN frame content within TX_SETUP or to filter
  65  * CAN messages with multiplex index within RX_SETUP, the number of
  66  * different filters is limited to 256 due to the one byte index value.
  67  */
  68 #define MAX_NFRAMES 256
  69
  70 /* use of last_frames[index].flags */
  71 #define RX_RECV    0x40 /* received data for this element */
  72 #define RX_THR     0x80 /* element not been sent due to throttle feature */
  73 #define BCM_CAN_FLAGS_MASK 0x3F /* to clean private flags after usage */
  74
  75 /* get best masking value for can_rx_register() for a given single can_id */
  76 #define REGMASK(id) ((id & CAN_EFF_FLAG) ? \
  77                      (CAN_EFF_MASK | CAN_EFF_FLAG | CAN_RTR_FLAG) : \
  78                      (CAN_SFF_MASK | CAN_EFF_FLAG | CAN_RTR_FLAG))
  79
  80 #define CAN_BCM_VERSION "20170425"
  81
  82 MODULE_DESCRIPTION("PF_CAN broadcast manager protocol");
  83 MODULE_LICENSE("Dual BSD/GPL");
  84 MODULE_AUTHOR("Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");
  85 MODULE_ALIAS("can-proto-2");
  86
  87 /*
  88  * easy access to the first 64 bit of can(fd)_frame payload. cp->data is
  89  * 64 bit aligned so the offset has to be multiples of 8 which is ensured
  90  * by the only callers in bcm_rx_cmp_to_index() bcm_rx_handler().
  91  */
  92 static inline u64 get_u64(const struct canfd_frame *cp, int offset)
  93 {
  94         return *(u64 *)(cp->data + offset);
  95 }
  96
  97 struct bcm_op {
  98         struct list_head list;
  99         int ifindex;
 100         canid_t can_id;
 101         u32 flags;
 102         unsigned long frames_abs, frames_filtered;
 103         struct bcm_timeval ival1, ival2;
 104         struct hrtimer timer, thrtimer;
 105         struct tasklet_struct tsklet, thrtsklet;
 106         ktime_t rx_stamp, kt_ival1, kt_ival2, kt_lastmsg;
 107         int rx_ifindex;
 108         int cfsiz;
 109         u32 count;
 110         u32 nframes;
 111         u32 currframe;
 112         /* void pointers to arrays of struct can[fd]_frame */
 113         void *frames;
 114         void *last_frames;
 115         struct canfd_frame sframe;
 116         struct canfd_frame last_sframe;
 117         struct sock *sk;
 118         struct net_device *rx_reg_dev;
 119 };
 120
 121 struct bcm_sock {
 122         struct sock sk;
 123         int bound;
 124         int ifindex;
 125         struct notifier_block notifier;
 126         struct list_head rx_ops;
 127         struct list_head tx_ops;
 128         unsigned long dropped_usr_msgs;
 129         struct proc_dir_entry *bcm_proc_read;
 130         char procname [32]; /* inode number in decimal with \0 */
 131 };
 132
 133 static inline struct bcm_sock *bcm_sk(const struct sock *sk)
 134 {
 135         return (struct bcm_sock *)sk;
 136 }
 137
 138 static inline ktime_t bcm_timeval_to_ktime(struct bcm_timeval tv)
 139 {
 140         return ktime_set(tv.tv_sec, tv.tv_usec * NSEC_PER_USEC);
 141 }
 142
 143 #define CFSIZ(flags) ((flags & CAN_FD_FRAME) ? CANFD_MTU : CAN_MTU)
 144 #define OPSIZ sizeof(struct bcm_op)
 145 #define MHSIZ sizeof(struct bcm_msg_head)
 146
 147 /*
 148  * procfs functions
 149  */
 150 static char *bcm_proc_getifname(struct net *net, char *result, int ifindex)
 151 {
 152         struct net_device *dev;
 153
 154         if (!ifindex)
 155                 return "any";
 156
 157         rcu_read_lock();
 158         dev = dev_get_by_index_rcu(net, ifindex);
 159         if (dev)
 160                 strcpy(result, dev->name);
 161         else
 162                 strcpy(result, "???");
 163         rcu_read_unlock();
 164
 165         return result;
 166 }
 167
 168 static int bcm_proc_show(struct seq_file *m, void *v)
 169 {
 170         char ifname[IFNAMSIZ];
 171         struct net *net = m->private;
 172         struct sock *sk = (struct sock *)PDE_DATA(m->file->f_inode);
 173         struct bcm_sock *bo = bcm_sk(sk);
 174         struct bcm_op *op;
 175
 176         seq_printf(m, ">>> socket %pK", sk->sk_socket);
 177         seq_printf(m, " / sk %pK", sk);
 178         seq_printf(m, " / bo %pK", bo);
 179         seq_printf(m, " / dropped %lu", bo->dropped_usr_msgs);
 180         seq_printf(m, " / bound %s", bcm_proc_getifname(net, ifname, bo->ifindex));
 181         seq_printf(m, " <<<\n");
 182
 183         list_for_each_entry(op, &bo->rx_ops, list) {
 184
 185                 unsigned long reduction;
 186
 187                 /* print only active entries & prevent division by zero */
 188                 if (!op->frames_abs)
 189                         continue;
 190
 191                 seq_printf(m, "rx_op: %03X %-5s ", op->can_id,
 192                            bcm_proc_getifname(net, ifname, op->ifindex));
 193
 194                 if (op->flags & CAN_FD_FRAME)
 195                         seq_printf(m, "(%u)", op->nframes);
 196                 else
 197                         seq_printf(m, "[%u]", op->nframes);
 198
 199                 seq_printf(m, "%c ", (op->flags & RX_CHECK_DLC) ? 'd' : ' ');
 200
 201                 if (op->kt_ival1)
 202                         seq_printf(m, "timeo=%lld ",
 203                                    (long long)ktime_to_us(op->kt_ival1));
 204
 205                 if (op->kt_ival2)
 206                         seq_printf(m, "thr=%lld ",
 207                                    (long long)ktime_to_us(op->kt_ival2));
 208
 209                 seq_printf(m, "# recv %ld (%ld) => reduction: ",
 210                            op->frames_filtered, op->frames_abs);
 211
 212                 reduction = 100 - (op->frames_filtered * 100) / op->frames_abs;
 213
 214                 seq_printf(m, "%s%ld%%\n",
 215                            (reduction == 100) ? "near " : "", reduction);
 216         }
 217
 218         list_for_each_entry(op, &bo->tx_ops, list) {
 219
 220                 seq_printf(m, "tx_op: %03X %s ", op->can_id,
 221                            bcm_proc_getifname(net, ifname, op->ifindex));
 222
 223                 if (op->flags & CAN_FD_FRAME)
 224                         seq_printf(m, "(%u) ", op->nframes);
 225                 else
 226                         seq_printf(m, "[%u] ", op->nframes);
 227
 228                 if (op->kt_ival1)
 229                         seq_printf(m, "t1=%lld ",
 230                                    (long long)ktime_to_us(op->kt_ival1));
 231
 232                 if (op->kt_ival2)
 233                         seq_printf(m, "t2=%lld ",
 234                                    (long long)ktime_to_us(op->kt_ival2));
 235
 236                 seq_printf(m, "# sent %ld\n", op->frames_abs);
 237         }
 238         seq_putc(m, '\n');
 239         return 0;
 240 }
 241
 242 static int bcm_proc_open(struct inode *inode, struct file *file)
 243 {
 244         return single_open_net(inode, file, bcm_proc_show);
 245 }
 246
 247 static const struct file_operations bcm_proc_fops = {
 248         .owner          = THIS_MODULE,
 249         .open           = bcm_proc_open,
 250         .read           = seq_read,
 251         .llseek         = seq_lseek,
 252         .release        = single_release,
 253 };
 254
 255 /*
 256  * bcm_can_tx - send the (next) CAN frame to the appropriate CAN interface
 257  *              of the given bcm tx op
 258  */
 259 static void bcm_can_tx(struct bcm_op *op)
 260 {
 261         struct sk_buff *skb;
 262         struct net_device *dev;
 263         struct canfd_frame *cf = op->frames + op->cfsiz * op->currframe;
 264
 265         /* no target device? => exit */
 266         if (!op->ifindex)
 267                 return;
 268
 269         dev = dev_get_by_index(sock_net(op->sk), op->ifindex);
 270         if (!dev) {
 271                 /* RFC: should this bcm_op remove itself here? */
 272                 return;
 273         }
 274
 275         skb = alloc_skb(op->cfsiz + sizeof(struct can_skb_priv), gfp_any());
 276         if (!skb)
 277                 goto out;
 278
 279         can_skb_reserve(skb);
 280         can_skb_prv(skb)->ifindex = dev->ifindex;
 281         can_skb_prv(skb)->skbcnt = 0;
 282
 283         memcpy(skb_put(skb, op->cfsiz), cf, op->cfsiz);
 284
 285         /* send with loopback */
 286         skb->dev = dev;
 287         can_skb_set_owner(skb, op->sk);
 288         can_send(skb, 1);
 289
 290         /* update statistics */
 291         op->currframe++;
 292         op->frames_abs++;
 293
 294         /* reached last frame? */
 295         if (op->currframe >= op->nframes)
 296                 op->currframe = 0;
 297 out:
 298         dev_put(dev);
 299 }
 300
 301 /*
 302  * bcm_send_to_user - send a BCM message to the userspace
 303  *                    (consisting of bcm_msg_head + x CAN frames)
 304  */
 305 static void bcm_send_to_user(struct bcm_op *op, struct bcm_msg_head *head,
 306                              struct canfd_frame *frames, int has_timestamp)
 307 {
 308         struct sk_buff *skb;
 309         struct canfd_frame *firstframe;
 310         struct sockaddr_can *addr;
 311         struct sock *sk = op->sk;
 312         unsigned int datalen = head->nframes * op->cfsiz;
 313         int err;
 314
 315         skb = alloc_skb(sizeof(*head) + datalen, gfp_any());
 316         if (!skb)
 317                 return;
 318
 319         memcpy(skb_put(skb, sizeof(*head)), head, sizeof(*head));
 320
 321         if (head->nframes) {
 322                 /* CAN frames starting here */
 323                 firstframe = (struct canfd_frame *)skb_tail_pointer(skb);
 324
 325                 memcpy(skb_put(skb, datalen), frames, datalen);
 326
 327                 /*
 328                  * the BCM uses the flags-element of the canfd_frame
 329                  * structure for internal purposes. This is only
 330                  * relevant for updates that are generated by the
 331                  * BCM, where nframes is 1
 332                  */
 333                 if (head->nframes == 1)
 334                         firstframe->flags &= BCM_CAN_FLAGS_MASK;
 335         }
 336
 337         if (has_timestamp) {
 338                 /* restore rx timestamp */
 339                 skb->tstamp = op->rx_stamp;
 340         }
 341
 342         /*
 343          *  Put the datagram to the queue so that bcm_recvmsg() can
 344          *  get it from there.  We need to pass the interface index to
 345          *  bcm_recvmsg().  We pass a whole struct sockaddr_can in skb->cb
 346          *  containing the interface index.
 347          */
 348
 349         sock_skb_cb_check_size(sizeof(struct sockaddr_can));
 350         addr = (struct sockaddr_can *)skb->cb;
 351         memset(addr, 0, sizeof(*addr));
 352         addr->can_family  = AF_CAN;
 353         addr->can_ifindex = op->rx_ifindex;
 354
 355         err = sock_queue_rcv_skb(sk, skb);
 356         if (err < 0) {
 357                 struct bcm_sock *bo = bcm_sk(sk);
 358
 359                 kfree_skb(skb);
 360                 /* don't care about overflows in this statistic */
 361                 bo->dropped_usr_msgs++;
 362         }
 363 }
 364
 365 static void bcm_tx_start_timer(struct bcm_op *op)
 366 {
 367         if (op->kt_ival1 && op->count)
 368                 hrtimer_start(&op->timer,
 369                               ktime_add(ktime_get(), op->kt_ival1),
 370                               HRTIMER_MODE_ABS);
 371         else if (op->kt_ival2)
 372                 hrtimer_start(&op->timer,
 373                               ktime_add(ktime_get(), op->kt_ival2),
 374                               HRTIMER_MODE_ABS);
 375 }
 376
 377 static void bcm_tx_timeout_tsklet(unsigned long data)
 378 {
 379         struct bcm_op *op = (struct bcm_op *)data;
 380         struct bcm_msg_head msg_head;
 381
 382         if (op->kt_ival1 && (op->count > 0)) {
 383
 384                 op->count--;
 385                 if (!op->count && (op->flags & TX_COUNTEVT)) {
 386
 387                         /* create notification to user */
 388                         msg_head.opcode  = TX_EXPIRED;
 389                         msg_head.flags   = op->flags;
 390                         msg_head.count   = op->count;
 391                         msg_head.ival1   = op->ival1;
 392                         msg_head.ival2   = op->ival2;
 393                         msg_head.can_id  = op->can_id;
 394                         msg_head.nframes = 0;
 395
 396                         bcm_send_to_user(op, &msg_head, NULL, 0);
 397                 }
 398                 bcm_can_tx(op);
 399
 400         } else if (op->kt_ival2)
 401                 bcm_can_tx(op);
 402
 403         bcm_tx_start_timer(op);
 404 }
 405
 406 /*
 407  * bcm_tx_timeout_handler - performs cyclic CAN frame transmissions
 408  */
 409 static enum hrtimer_restart bcm_tx_timeout_handler(struct hrtimer *hrtimer)
 410 {
 411         struct bcm_op *op = container_of(hrtimer, struct bcm_op, timer);
 412
 413         tasklet_schedule(&op->tsklet);
 414
 415         return HRTIMER_NORESTART;
 416 }
 417
 418 /*
 419  * bcm_rx_changed - create a RX_CHANGED notification due to changed content
 420  */
 421 static void bcm_rx_changed(struct bcm_op *op, struct canfd_frame *data)
 422 {
 423         struct bcm_msg_head head;
 424
 425         /* update statistics */
 426         op->frames_filtered++;
 427
 428         /* prevent statistics overflow */
 429         if (op->frames_filtered > ULONG_MAX/100)
 430                 op->frames_filtered = op->frames_abs = 0;
 431
 432         /* this element is not throttled anymore */
 433         data->flags &= (BCM_CAN_FLAGS_MASK|RX_RECV);
 434
 435         head.opcode  = RX_CHANGED;
 436         head.flags   = op->flags;
 437         head.count   = op->count;
 438         head.ival1   = op->ival1;
 439         head.ival2   = op->ival2;
 440         head.can_id  = op->can_id;
 441         head.nframes = 1;
 442
 443         bcm_send_to_user(op, &head, data, 1);
 444 }
 445
 446 /*
 447  * bcm_rx_update_and_send - process a detected relevant receive content change
 448  *                          1. update the last received data
 449  *                          2. send a notification to the user (if possible)
 450  */
 451 static void bcm_rx_update_and_send(struct bcm_op *op,
 452                                    struct canfd_frame *lastdata,
 453                                    const struct canfd_frame *rxdata)
 454 {
 455         memcpy(lastdata, rxdata, op->cfsiz);
 456
 457         /* mark as used and throttled by default */
 458         lastdata->flags |= (RX_RECV|RX_THR);
 459
 460         /* throttling mode inactive ? */
 461         if (!op->kt_ival2) {
 462                 /* send RX_CHANGED to the user immediately */
 463                 bcm_rx_changed(op, lastdata);
 464                 return;
 465         }
 466
 467         /* with active throttling timer we are just done here */
 468         if (hrtimer_active(&op->thrtimer))
 469                 return;
 470
 471         /* first reception with enabled throttling mode */
 472         if (!op->kt_lastmsg)
 473                 goto rx_changed_settime;
 474
 475         /* got a second frame inside a potential throttle period? */
 476         if (ktime_us_delta(ktime_get(), op->kt_lastmsg) <
 477             ktime_to_us(op->kt_ival2)) {
 478                 /* do not send the saved data - only start throttle timer */
 479                 hrtimer_start(&op->thrtimer,
 480                               ktime_add(op->kt_lastmsg, op->kt_ival2),
 481                               HRTIMER_MODE_ABS);
 482                 return;
 483         }
 484
 485         /* the gap was that big, that throttling was not needed here */
 486 rx_changed_settime:
 487         bcm_rx_changed(op, lastdata);
 488         op->kt_lastmsg = ktime_get();
 489 }
 490
 491 /*
 492  * bcm_rx_cmp_to_index - (bit)compares the currently received data to formerly
 493  *                       received data stored in op->last_frames[]
 494  */
 495 static void bcm_rx_cmp_to_index(struct bcm_op *op, unsigned int index,
 496                                 const struct canfd_frame *rxdata)
 497 {
 498         struct canfd_frame *cf = op->frames + op->cfsiz * index;
 499         struct canfd_frame *lcf = op->last_frames + op->cfsiz * index;
 500         int i;
 501
 502         /*
 503          * no one uses the MSBs of flags for comparison,
 504          * so we use it here to detect the first time of reception
 505          */
 506
 507         if (!(lcf->flags & RX_RECV)) {
 508                 /* received data for the first time => send update to user */
 509                 bcm_rx_update_and_send(op, lcf, rxdata);
 510                 return;
 511         }
 512
 513         /* do a real check in CAN frame data section */
 514         for (i = 0; i < rxdata->len; i += 8) {
 515                 if ((get_u64(cf, i) & get_u64(rxdata, i)) !=
 516                     (get_u64(cf, i) & get_u64(lcf, i))) {
 517                         bcm_rx_update_and_send(op, lcf, rxdata);
 518                         return;
 519                 }
 520         }
 521
 522         if (op->flags & RX_CHECK_DLC) {
 523                 /* do a real check in CAN frame length */
 524                 if (rxdata->len != lcf->len) {
 525                         bcm_rx_update_and_send(op, lcf, rxdata);
 526                         return;
 527                 }
 528         }
 529 }
 530
 531 /*
 532  * bcm_rx_starttimer - enable timeout monitoring for CAN frame reception
 533  */
 534 static void bcm_rx_starttimer(struct bcm_op *op)
 535 {
 536         if (op->flags & RX_NO_AUTOTIMER)
 537                 return;
 538
 539         if (op->kt_ival1)
 540                 hrtimer_start(&op->timer, op->kt_ival1, HRTIMER_MODE_REL);
 541 }
 542
 543 static void bcm_rx_timeout_tsklet(unsigned long data)
 544 {
 545         struct bcm_op *op = (struct bcm_op *)data;
 546         struct bcm_msg_head msg_head;
 547
 548         /* create notification to user */
 549         msg_head.opcode  = RX_TIMEOUT;
 550         msg_head.flags   = op->flags;
 551         msg_head.count   = op->count;
 552         msg_head.ival1   = op->ival1;
 553         msg_head.ival2   = op->ival2;
 554         msg_head.can_id  = op->can_id;
 555         msg_head.nframes = 0;
 556
 557         bcm_send_to_user(op, &msg_head, NULL, 0);
 558 }
 559
 560 /*
 561  * bcm_rx_timeout_handler - when the (cyclic) CAN frame reception timed out
 562  */
 563 static enum hrtimer_restart bcm_rx_timeout_handler(struct hrtimer *hrtimer)
 564 {
 565         struct bcm_op *op = container_of(hrtimer, struct bcm_op, timer);
 566
 567         /* schedule before NET_RX_SOFTIRQ */
 568         tasklet_hi_schedule(&op->tsklet);
 569
 570         /* no restart of the timer is done here! */
 571
 572         /* if user wants to be informed, when cyclic CAN-Messages come back */
 573         if ((op->flags & RX_ANNOUNCE_RESUME) && op->last_frames) {
 574                 /* clear received CAN frames to indicate 'nothing received' */
 575                 memset(op->last_frames, 0, op->nframes * op->cfsiz);
 576         }
 577
 578         return HRTIMER_NORESTART;
 579 }
 580
 581 /*
 582  * bcm_rx_do_flush - helper for bcm_rx_thr_flush
 583  */
 584 static inline int bcm_rx_do_flush(struct bcm_op *op, int update,
 585                                   unsigned int index)
 586 {
 587         struct canfd_frame *lcf = op->last_frames + op->cfsiz * index;
 588
 589         if ((op->last_frames) && (lcf->flags & RX_THR)) {
 590                 if (update)
 591                         bcm_rx_changed(op, lcf);
 592                 return 1;
 593         }
 594         return 0;
 595 }
 596
 597 /*
 598  * bcm_rx_thr_flush - Check for throttled data and send it to the userspace
 599  *
 600  * update == 0 : just check if throttled data is available  (any irq context)
 601  * update == 1 : check and send throttled data to userspace (soft_irq context)
 602  */
 603 static int bcm_rx_thr_flush(struct bcm_op *op, int update)
 604 {
 605         int updated = 0;
 606
 607         if (op->nframes > 1) {
 608                 unsigned int i;
 609
 610                 /* for MUX filter we start at index 1 */
 611                 for (i = 1; i < op->nframes; i++)
 612                         updated += bcm_rx_do_flush(op, update, i);
 613
 614         } else {
 615                 /* for RX_FILTER_ID and simple filter */
 616                 updated += bcm_rx_do_flush(op, update, 0);
 617         }
 618
 619         return updated;
 620 }
 621
 622 static void bcm_rx_thr_tsklet(unsigned long data)
 623 {
 624         struct bcm_op *op = (struct bcm_op *)data;
 625
 626         /* push the changed data to the userspace */
 627         bcm_rx_thr_flush(op, 1);
 628 }
 629
 630 /*
 631  * bcm_rx_thr_handler - the time for blocked content updates is over now:
 632  *                      Check for throttled data and send it to the userspace
 633  */
 634 static enum hrtimer_restart bcm_rx_thr_handler(struct hrtimer *hrtimer)
 635 {
 636         struct bcm_op *op = container_of(hrtimer, struct bcm_op, thrtimer);
 637
 638         tasklet_schedule(&op->thrtsklet);
 639
 640         if (bcm_rx_thr_flush(op, 0)) {
 641                 hrtimer_forward(hrtimer, ktime_get(), op->kt_ival2);
 642                 return HRTIMER_RESTART;
 643         } else {
 644                 /* rearm throttle handling */
 645                 op->kt_lastmsg = 0;
 646                 return HRTIMER_NORESTART;
 647         }
 648 }
 649
 650 /*
 651  * bcm_rx_handler - handle a CAN frame reception
 652  */
 653 static void bcm_rx_handler(struct sk_buff *skb, void *data)
 654 {
 655         struct bcm_op *op = (struct bcm_op *)data;
 656         const struct canfd_frame *rxframe = (struct canfd_frame *)skb->data;
 657         unsigned int i;
 658
 659         if (op->can_id != rxframe->can_id)
 660                 return;
 661
 662         /* make sure to handle the correct frame type (CAN / CAN FD) */
 663         if (skb->len != op->cfsiz)
 664                 return;
 665
 666         /* disable timeout */
 667         hrtimer_cancel(&op->timer);
 668
 669         /* save rx timestamp */
 670         op->rx_stamp = skb->tstamp;
 671         /* save originator for recvfrom() */
 672         op->rx_ifindex = skb->dev->ifindex;
 673         /* update statistics */
 674         op->frames_abs++;
 675
 676         if (op->flags & RX_RTR_FRAME) {
 677                 /* send reply for RTR-request (placed in op->frames[0]) */
 678                 bcm_can_tx(op);
 679                 return;
 680         }
 681
 682         if (op->flags & RX_FILTER_ID) {
 683                 /* the easiest case */
 684                 bcm_rx_update_and_send(op, op->last_frames, rxframe);
 685                 goto rx_starttimer;
 686         }
 687
 688         if (op->nframes == 1) {
 689                 /* simple compare with index 0 */
 690                 bcm_rx_cmp_to_index(op, 0, rxframe);
 691                 goto rx_starttimer;
 692         }
 693
 694         if (op->nframes > 1) {
 695                 /*
 696                  * multiplex compare
 697                  *
 698                  * find the first multiplex mask that fits.
 699                  * Remark: The MUX-mask is stored in index 0 - but only the
 700                  * first 64 bits of the frame data[] are relevant (CAN FD)
 701                  */
 702
 703                 for (i = 1; i < op->nframes; i++) {
 704                         if ((get_u64(op->frames, 0) & get_u64(rxframe, 0)) ==
 705                             (get_u64(op->frames, 0) &
 706                              get_u64(op->frames + op->cfsiz * i, 0))) {
 707                                 bcm_rx_cmp_to_index(op, i, rxframe);
 708                                 break;
 709                         }
 710                 }
 711         }
 712
 713 rx_starttimer:
 714         bcm_rx_starttimer(op);
 715 }
 716
 717 /*
 718  * helpers for bcm_op handling: find & delete bcm [rx|tx] op elements
 719  */
 720 static struct bcm_op *bcm_find_op(struct list_head *ops,
 721                                   struct bcm_msg_head *mh, int ifindex)
 722 {
 723         struct bcm_op *op;
 724
 725         list_for_each_entry(op, ops, list) {
 726                 if ((op->can_id == mh->can_id) && (op->ifindex == ifindex) &&
 727                     (op->flags & CAN_FD_FRAME) == (mh->flags & CAN_FD_FRAME))
 728                         return op;
 729         }
 730
 731         return NULL;
 732 }
 733
 734 static void bcm_remove_op(struct bcm_op *op)
 735 {
 736         if (op->tsklet.func) {
 737                 while (test_bit(TASKLET_STATE_SCHED, &op->tsklet.state) ||
 738                        test_bit(TASKLET_STATE_RUN, &op->tsklet.state) ||
 739                        hrtimer_active(&op->timer)) {
 740                         hrtimer_cancel(&op->timer);
 741                         tasklet_kill(&op->tsklet);
 742                 }
 743         }
 744
 745         if (op->thrtsklet.func) {
 746                 while (test_bit(TASKLET_STATE_SCHED, &op->thrtsklet.state) ||
 747                        test_bit(TASKLET_STATE_RUN, &op->thrtsklet.state) ||
 748                        hrtimer_active(&op->thrtimer)) {
 749                         hrtimer_cancel(&op->thrtimer);
 750                         tasklet_kill(&op->thrtsklet);
 751                 }
 752         }
 753
 754         if ((op->frames) && (op->frames != &op->sframe))
 755                 kfree(op->frames);
 756
 757         if ((op->last_frames) && (op->last_frames != &op->last_sframe))
 758                 kfree(op->last_frames);
 759
 760         kfree(op);
 761 }
 762
 763 static void bcm_rx_unreg(struct net_device *dev, struct bcm_op *op)
 764 {
 765         if (op->rx_reg_dev == dev) {
 766                 can_rx_unregister(dev_net(dev), dev, op->can_id,
 767                                   REGMASK(op->can_id), bcm_rx_handler, op);
 768
 769                 /* mark as removed subscription */
 770                 op->rx_reg_dev = NULL;
 771         } else
 772                 printk(KERN_ERR "can-bcm: bcm_rx_unreg: registered device "
 773                        "mismatch %p %p\n", op->rx_reg_dev, dev);
 774 }
 775
 776 /*
 777  * bcm_delete_rx_op - find and remove a rx op (returns number of removed ops)
 778  */
 779 static int bcm_delete_rx_op(struct list_head *ops, struct bcm_msg_head *mh,
 780                             int ifindex)
 781 {
 782         struct bcm_op *op, *n;
 783
 784         list_for_each_entry_safe(op, n, ops, list) {
 785                 if ((op->can_id == mh->can_id) && (op->ifindex == ifindex) &&
 786                     (op->flags & CAN_FD_FRAME) == (mh->flags & CAN_FD_FRAME)) {
 787
 788                         /*
 789                          * Don't care if we're bound or not (due to netdev
 790                          * problems) can_rx_unregister() is always a save
 791                          * thing to do here.
 792                          */
 793                         if (op->ifindex) {
 794                                 /*
 795                                  * Only remove subscriptions that had not
 796                                  * been removed due to NETDEV_UNREGISTER
 797                                  * in bcm_notifier()
 798                                  */
 799                                 if (op->rx_reg_dev) {
 800                                         struct net_device *dev;
 801
 802                                         dev = dev_get_by_index(sock_net(op->sk),
 803                                                                op->ifindex);
 804                                         if (dev) {
 805                                                 bcm_rx_unreg(dev, op);
 806                                                 dev_put(dev);
 807                                         }
 808                                 }
 809                         } else
 810                                 can_rx_unregister(sock_net(op->sk), NULL,
 811                                                   op->can_id,
 812                                                   REGMASK(op->can_id),
 813                                                   bcm_rx_handler, op);
 814
 815                         list_del(&op->list);
 816                         bcm_remove_op(op);
 817                         return 1; /* done */
 818                 }
 819         }
 820
 821         return 0; /* not found */
 822 }
 823
 824 /*
 825  * bcm_delete_tx_op - find and remove a tx op (returns number of removed ops)
 826  */
 827 static int bcm_delete_tx_op(struct list_head *ops, struct bcm_msg_head *mh,
 828                             int ifindex)
 829 {
 830         struct bcm_op *op, *n;
 831
 832         list_for_each_entry_safe(op, n, ops, list) {
 833                 if ((op->can_id == mh->can_id) && (op->ifindex == ifindex) &&
 834                     (op->flags & CAN_FD_FRAME) == (mh->flags & CAN_FD_FRAME)) {
 835                         list_del(&op->list);
 836                         bcm_remove_op(op);
 837                         return 1; /* done */
 838                 }
 839         }
 840
 841         return 0; /* not found */
 842 }
 843
 844 /*
 845  * bcm_read_op - read out a bcm_op and send it to the user (for bcm_sendmsg)
 846  */
 847 static int bcm_read_op(struct list_head *ops, struct bcm_msg_head *msg_head,
 848                        int ifindex)
 849 {
 850         struct bcm_op *op = bcm_find_op(ops, msg_head, ifindex);
 851
 852         if (!op)
 853                 return -EINVAL;
 854
 855         /* put current values into msg_head */
 856         msg_head->flags   = op->flags;
 857         msg_head->count   = op->count;
 858         msg_head->ival1   = op->ival1;
 859         msg_head->ival2   = op->ival2;
 860         msg_head->nframes = op->nframes;
 861
 862         bcm_send_to_user(op, msg_head, op->frames, 0);
 863
 864         return MHSIZ;
 865 }
 866
 867 /*
 868  * bcm_tx_setup - create or update a bcm tx op (for bcm_sendmsg)
 869  */
 870 static int bcm_tx_setup(struct bcm_msg_head *msg_head, struct msghdr *msg,
 871                         int ifindex, struct sock *sk)
 872 {
 873         struct bcm_sock *bo = bcm_sk(sk);
 874         struct bcm_op *op;
 875         struct canfd_frame *cf;
 876         unsigned int i;
 877         int err;
 878
 879         /* we need a real device to send frames */
 880         if (!ifindex)
 881                 return -ENODEV;
 882
 883         /* check nframes boundaries - we need at least one CAN frame */
 884         if (msg_head->nframes < 1 || msg_head->nframes > MAX_NFRAMES)
 885                 return -EINVAL;
 886
 887         /* check the given can_id */
 888         op = bcm_find_op(&bo->tx_ops, msg_head, ifindex);
 889         if (op) {
 890                 /* update existing BCM operation */
 891
 892                 /*
 893                  * Do we need more space for the CAN frames than currently
 894                  * allocated? -> This is a _really_ unusual use-case and
 895                  * therefore (complexity / locking) it is not supported.
 896                  */
 897                 if (msg_head->nframes > op->nframes)
 898                         return -E2BIG;
 899
 900                 /* update CAN frames content */
 901                 for (i = 0; i < msg_head->nframes; i++) {
 902
 903                         cf = op->frames + op->cfsiz * i;
 904                         err = memcpy_from_msg((u8 *)cf, msg, op->cfsiz);
 905
 906                         if (op->flags & CAN_FD_FRAME) {
 907                                 if (cf->len > 64)
 908                                         err = -EINVAL;
 909                         } else {
 910                                 if (cf->len > 8)
 911                                         err = -EINVAL;
 912                         }
 913
 914                         if (err < 0)
 915                                 return err;
 916
 917                         if (msg_head->flags & TX_CP_CAN_ID) {
 918                                 /* copy can_id into frame */
 919                                 cf->can_id = msg_head->can_id;
 920                         }
 921                 }
 922                 op->flags = msg_head->flags;
 923
 924         } else {
 925                 /* insert new BCM operation for the given can_id */
 926
 927                 op = kzalloc(OPSIZ, GFP_KERNEL);
 928                 if (!op)
 929                         return -ENOMEM;
 930
 931                 op->can_id = msg_head->can_id;
 932                 op->cfsiz = CFSIZ(msg_head->flags);
 933                 op->flags = msg_head->flags;
 934
 935                 /* create array for CAN frames and copy the data */
 936                 if (msg_head->nframes > 1) {
 937                         op->frames = kmalloc(msg_head->nframes * op->cfsiz,
 938                                              GFP_KERNEL);
 939                         if (!op->frames) {
 940                                 kfree(op);
 941                                 return -ENOMEM;
 942                         }
 943                 } else
 944                         op->frames = &op->sframe;
 945
 946                 for (i = 0; i < msg_head->nframes; i++) {
 947
 948                         cf = op->frames + op->cfsiz * i;
 949                         err = memcpy_from_msg((u8 *)cf, msg, op->cfsiz);
 950
 951                         if (op->flags & CAN_FD_FRAME) {
 952                                 if (cf->len > 64)
 953                                         err = -EINVAL;
 954                         } else {
 955                                 if (cf->len > 8)
 956                                         err = -EINVAL;
 957                         }
 958
 959                         if (err < 0) {
 960                                 if (op->frames != &op->sframe)
 961                                         kfree(op->frames);
 962                                 kfree(op);
 963                                 return err;
 964                         }
 965
 966                         if (msg_head->flags & TX_CP_CAN_ID) {
 967                                 /* copy can_id into frame */
 968                                 cf->can_id = msg_head->can_id;
 969                         }
 970                 }
 971
 972                 /* tx_ops never compare with previous received messages */
 973                 op->last_frames = NULL;
 974
 975                 /* bcm_can_tx / bcm_tx_timeout_handler needs this */
 976                 op->sk = sk;
 977                 op->ifindex = ifindex;
 978
 979                 /* initialize uninitialized (kzalloc) structure */
 980                 hrtimer_init(&op->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
 981                 op->timer.function = bcm_tx_timeout_handler;
 982
 983                 /* initialize tasklet for tx countevent notification */
 984                 tasklet_init(&op->tsklet, bcm_tx_timeout_tsklet,
 985                              (unsigned long) op);
 986
 987                 /* currently unused in tx_ops */
 988                 hrtimer_init(&op->thrtimer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
 989
 990                 /* add this bcm_op to the list of the tx_ops */
 991                 list_add(&op->list, &bo->tx_ops);
 992
 993         } /* if ((op = bcm_find_op(&bo->tx_ops, msg_head->can_id, ifindex))) */
 994
 995         if (op->nframes != msg_head->nframes) {
 996                 op->nframes   = msg_head->nframes;
 997                 /* start multiple frame transmission with index 0 */
 998                 op->currframe = 0;
 999         }
1000
1001         /* check flags */
1002
1003         if (op->flags & TX_RESET_MULTI_IDX) {
1004                 /* start multiple frame transmission with index 0 */
1005                 op->currframe = 0;
1006         }
1007
1008         if (op->flags & SETTIMER) {
1009                 /* set timer values */
1010                 op->count = msg_head->count;
1011                 op->ival1 = msg_head->ival1;
1012                 op->ival2 = msg_head->ival2;
1013                 op->kt_ival1 = bcm_timeval_to_ktime(msg_head->ival1);
1014                 op->kt_ival2 = bcm_timeval_to_ktime(msg_head->ival2);
1015
1016                 /* disable an active timer due to zero values? */
1017                 if (!op->kt_ival1 && !op->kt_ival2)
1018                         hrtimer_cancel(&op->timer);
1019         }
1020
1021         if (op->flags & STARTTIMER) {
1022                 hrtimer_cancel(&op->timer);
1023                 /* spec: send CAN frame when starting timer */
1024                 op->flags |= TX_ANNOUNCE;
1025         }
1026
1027         if (op->flags & TX_ANNOUNCE) {
1028                 bcm_can_tx(op);
1029                 if (op->count)
1030                         op->count--;
1031         }
1032
1033         if (op->flags & STARTTIMER)
1034                 bcm_tx_start_timer(op);
1035
1036         return msg_head->nframes * op->cfsiz + MHSIZ;
1037 }
1038
1039 /*
1040  * bcm_rx_setup - create or update a bcm rx op (for bcm_sendmsg)
1041  */
1042 static int bcm_rx_setup(struct bcm_msg_head *msg_head, struct msghdr *msg,
1043                         int ifindex, struct sock *sk)
1044 {
1045         struct bcm_sock *bo = bcm_sk(sk);
1046         struct bcm_op *op;
1047         int do_rx_register;
1048         int err = 0;
1049
1050         if ((msg_head->flags & RX_FILTER_ID) || (!(msg_head->nframes))) {
1051                 /* be robust against wrong usage ... */
1052                 msg_head->flags |= RX_FILTER_ID;
1053                 /* ignore trailing garbage */
1054                 msg_head->nframes = 0;
1055         }
1056
1057         /* the first element contains the mux-mask => MAX_NFRAMES + 1  */
1058         if (msg_head->nframes > MAX_NFRAMES + 1)
1059                 return -EINVAL;
1060
1061         if ((msg_head->flags & RX_RTR_FRAME) &&
1062             ((msg_head->nframes != 1) ||
1063              (!(msg_head->can_id & CAN_RTR_FLAG))))
1064                 return -EINVAL;
1065
1066         /* check the given can_id */
1067         op = bcm_find_op(&bo->rx_ops, msg_head, ifindex);
1068         if (op) {
1069                 /* update existing BCM operation */
1070
1071                 /*
1072                  * Do we need more space for the CAN frames than currently
1073                  * allocated? -> This is a _really_ unusual use-case and
1074                  * therefore (complexity / locking) it is not supported.
1075                  */
1076                 if (msg_head->nframes > op->nframes)
1077                         return -E2BIG;
1078
1079                 if (msg_head->nframes) {
1080                         /* update CAN frames content */
1081                         err = memcpy_from_msg(op->frames, msg,
1082                                               msg_head->nframes * op->cfsiz);
1083                         if (err < 0)
1084                                 return err;
1085
1086                         /* clear last_frames to indicate 'nothing received' */
1087                         memset(op->last_frames, 0, msg_head->nframes * op->cfsiz);
1088                 }
1089
1090                 op->nframes = msg_head->nframes;
1091                 op->flags = msg_head->flags;
1092
1093                 /* Only an update -> do not call can_rx_register() */
1094                 do_rx_register = 0;
1095
1096         } else {
1097                 /* insert new BCM operation for the given can_id */
1098                 op = kzalloc(OPSIZ, GFP_KERNEL);
1099                 if (!op)
1100                         return -ENOMEM;
1101
1102                 op->can_id = msg_head->can_id;
1103                 op->nframes = msg_head->nframes;
1104                 op->cfsiz = CFSIZ(msg_head->flags);
1105                 op->flags = msg_head->flags;
1106
1107                 if (msg_head->nframes > 1) {
1108                         /* create array for CAN frames and copy the data */
1109                         op->frames = kmalloc(msg_head->nframes * op->cfsiz,
1110                                              GFP_KERNEL);
1111                         if (!op->frames) {
1112                                 kfree(op);
1113                                 return -ENOMEM;
1114                         }
1115
1116                         /* create and init array for received CAN frames */
1117                         op->last_frames = kzalloc(msg_head->nframes * op->cfsiz,
1118                                                   GFP_KERNEL);
1119                         if (!op->last_frames) {
1120                                 kfree(op->frames);
1121                                 kfree(op);
1122                                 return -ENOMEM;
1123                         }
1124
1125                 } else {
1126                         op->frames = &op->sframe;
1127                         op->last_frames = &op->last_sframe;
1128                 }
1129
1130                 if (msg_head->nframes) {
1131                         err = memcpy_from_msg(op->frames, msg,
1132                                               msg_head->nframes * op->cfsiz);
1133                         if (err < 0) {
1134                                 if (op->frames != &op->sframe)
1135                                         kfree(op->frames);
1136                                 if (op->last_frames != &op->last_sframe)
1137                                         kfree(op->last_frames);
1138                                 kfree(op);
1139                                 return err;
1140                         }
1141                 }
1142
1143                 /* bcm_can_tx / bcm_tx_timeout_handler needs this */
1144                 op->sk = sk;
1145                 op->ifindex = ifindex;
1146
1147                 /* ifindex for timeout events w/o previous frame reception */
1148                 op->rx_ifindex = ifindex;
1149
1150                 /* initialize uninitialized (kzalloc) structure */
1151                 hrtimer_init(&op->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
1152                 op->timer.function = bcm_rx_timeout_handler;
1153
1154                 /* initialize tasklet for rx timeout notification */
1155                 tasklet_init(&op->tsklet, bcm_rx_timeout_tsklet,
1156                              (unsigned long) op);
1157
1158                 hrtimer_init(&op->thrtimer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
1159                 op->thrtimer.function = bcm_rx_thr_handler;
1160
1161                 /* initialize tasklet for rx throttle handling */
1162                 tasklet_init(&op->thrtsklet, bcm_rx_thr_tsklet,
1163                              (unsigned long) op);
1164
1165                 /* add this bcm_op to the list of the rx_ops */
1166                 list_add(&op->list, &bo->rx_ops);
1167
1168                 /* call can_rx_register() */
1169                 do_rx_register = 1;
1170
1171         } /* if ((op = bcm_find_op(&bo->rx_ops, msg_head->can_id, ifindex))) */
1172
1173         /* check flags */
1174
1175         if (op->flags & RX_RTR_FRAME) {
1176                 struct canfd_frame *frame0 = op->frames;
1177
1178                 /* no timers in RTR-mode */
1179                 hrtimer_cancel(&op->thrtimer);
1180                 hrtimer_cancel(&op->timer);
1181
1182                 /*
1183                  * funny feature in RX(!)_SETUP only for RTR-mode:
1184                  * copy can_id into frame BUT without RTR-flag to
1185                  * prevent a full-load-loopback-test ... ;-]
1186                  */
1187                 if ((op->flags & TX_CP_CAN_ID) ||
1188                     (frame0->can_id == op->can_id))
1189                         frame0->can_id = op->can_id & ~CAN_RTR_FLAG;
1190
1191         } else {
1192                 if (op->flags & SETTIMER) {
1193
1194                         /* set timer value */
1195                         op->ival1 = msg_head->ival1;
1196                         op->ival2 = msg_head->ival2;
1197                         op->kt_ival1 = bcm_timeval_to_ktime(msg_head->ival1);
1198                         op->kt_ival2 = bcm_timeval_to_ktime(msg_head->ival2);
1199
1200                         /* disable an active timer due to zero value? */
1201                         if (!op->kt_ival1)
1202                                 hrtimer_cancel(&op->timer);
1203
1204                         /*
1205                          * In any case cancel the throttle timer, flush
1206                          * potentially blocked msgs and reset throttle handling
1207                          */
1208                         op->kt_lastmsg = 0;
1209                         hrtimer_cancel(&op->thrtimer);
1210                         bcm_rx_thr_flush(op, 1);
1211                 }
1212
1213                 if ((op->flags & STARTTIMER) && op->kt_ival1)
1214                         hrtimer_start(&op->timer, op->kt_ival1,
1215                                       HRTIMER_MODE_REL);
1216         }
1217
1218         /* now we can register for can_ids, if we added a new bcm_op */
1219         if (do_rx_register) {
1220                 if (ifindex) {
1221                         struct net_device *dev;
1222
1223                         dev = dev_get_by_index(sock_net(sk), ifindex);
1224                         if (dev) {
1225                                 err = can_rx_register(sock_net(sk), dev,
1226                                                       op->can_id,
1227                                                       REGMASK(op->can_id),
1228                                                       bcm_rx_handler, op,
1229                                                       "bcm", sk);
1230
1231                                 op->rx_reg_dev = dev;
1232                                 dev_put(dev);
1233                         }
1234
1235                 } else
1236                         err = can_rx_register(sock_net(sk), NULL, op->can_id,
1237                                               REGMASK(op->can_id),
1238                                               bcm_rx_handler, op, "bcm", sk);
1239                 if (err) {
1240                         /* this bcm rx op is broken -> remove it */
1241                         list_del(&op->list);
1242                         bcm_remove_op(op);
1243                         return err;
1244                 }
1245         }
1246
1247         return msg_head->nframes * op->cfsiz + MHSIZ;
1248 }
1249
1250 /*
1251  * bcm_tx_send - send a single CAN frame to the CAN interface (for bcm_sendmsg)
1252  */
1253 static int bcm_tx_send(struct msghdr *msg, int ifindex, struct sock *sk,
1254                        int cfsiz)
1255 {
1256         struct sk_buff *skb;
1257         struct net_device *dev;
1258         int err;
1259
1260         /* we need a real device to send frames */
1261         if (!ifindex)
1262                 return -ENODEV;
1263
1264         skb = alloc_skb(cfsiz + sizeof(struct can_skb_priv), GFP_KERNEL);
1265         if (!skb)
1266                 return -ENOMEM;
1267
1268         can_skb_reserve(skb);
1269
1270         err = memcpy_from_msg(skb_put(skb, cfsiz), msg, cfsiz);
1271         if (err < 0) {
1272                 kfree_skb(skb);
1273                 return err;
1274         }
1275
1276         dev = dev_get_by_index(sock_net(sk), ifindex);
1277         if (!dev) {
1278                 kfree_skb(skb);
1279                 return -ENODEV;
1280         }
1281
1282         can_skb_prv(skb)->ifindex = dev->ifindex;
1283         can_skb_prv(skb)->skbcnt = 0;
1284         skb->dev = dev;
1285         can_skb_set_owner(skb, sk);
1286         err = can_send(skb, 1); /* send with loopback */
1287         dev_put(dev);
1288
1289         if (err)
1290                 return err;
1291
1292         return cfsiz + MHSIZ;
1293 }
1294
1295 /*
1296  * bcm_sendmsg - process BCM commands (opcodes) from the userspace
1297  */
1298 static int bcm_sendmsg(struct socket *sock, struct msghdr *msg, size_t size)
1299 {
1300         struct sock *sk = sock->sk;
1301         struct bcm_sock *bo = bcm_sk(sk);
1302         int ifindex = bo->ifindex; /* default ifindex for this bcm_op */
1303         struct bcm_msg_head msg_head;
1304         int cfsiz;
1305         int ret; /* read bytes or error codes as return value */
1306
1307         if (!bo->bound)
1308                 return -ENOTCONN;
1309
1310         /* check for valid message length from userspace */
1311         if (size < MHSIZ)
1312                 return -EINVAL;
1313
1314         /* read message head information */
1315         ret = memcpy_from_msg((u8 *)&msg_head, msg, MHSIZ);
1316         if (ret < 0)
1317                 return ret;
1318
1319         cfsiz = CFSIZ(msg_head.flags);
1320         if ((size - MHSIZ) % cfsiz)
1321                 return -EINVAL;
1322
1323         /* check for alternative ifindex for this bcm_op */
1324
1325         if (!ifindex && msg->msg_name) {
1326                 /* no bound device as default => check msg_name */
1327                 DECLARE_SOCKADDR(struct sockaddr_can *, addr, msg->msg_name);
1328
1329                 if (msg->msg_namelen < sizeof(*addr))
1330                         return -EINVAL;
1331
1332                 if (addr->can_family != AF_CAN)
1333                         return -EINVAL;
1334
1335                 /* ifindex from sendto() */
1336                 ifindex = addr->can_ifindex;
1337
1338                 if (ifindex) {
1339                         struct net_device *dev;
1340
1341                         dev = dev_get_by_index(sock_net(sk), ifindex);
1342                         if (!dev)
1343                                 return -ENODEV;
1344
1345                         if (dev->type != ARPHRD_CAN) {
1346                                 dev_put(dev);
1347                                 return -ENODEV;
1348                         }
1349
1350                         dev_put(dev);
1351                 }
1352         }
1353
1354         lock_sock(sk);
1355
1356         switch (msg_head.opcode) {
1357
1358         case TX_SETUP:
1359                 ret = bcm_tx_setup(&msg_head, msg, ifindex, sk);
1360                 break;
1361
1362         case RX_SETUP:
1363                 ret = bcm_rx_setup(&msg_head, msg, ifindex, sk);
1364                 break;
1365
1366         case TX_DELETE:
1367                 if (bcm_delete_tx_op(&bo->tx_ops, &msg_head, ifindex))
1368                         ret = MHSIZ;
1369                 else
1370                         ret = -EINVAL;
1371                 break;
1372
1373         case RX_DELETE:
1374                 if (bcm_delete_rx_op(&bo->rx_ops, &msg_head, ifindex))
1375                         ret = MHSIZ;
1376                 else
1377                         ret = -EINVAL;
1378                 break;
1379
1380         case TX_READ:
1381                 /* reuse msg_head for the reply to TX_READ */
1382                 msg_head.opcode  = TX_STATUS;
1383                 ret = bcm_read_op(&bo->tx_ops, &msg_head, ifindex);
1384                 break;
1385
1386         case RX_READ:
1387                 /* reuse msg_head for the reply to RX_READ */
1388                 msg_head.opcode  = RX_STATUS;
1389                 ret = bcm_read_op(&bo->rx_ops, &msg_head, ifindex);
1390                 break;
1391
1392         case TX_SEND:
1393                 /* we need exactly one CAN frame behind the msg head */
1394                 if ((msg_head.nframes != 1) || (size != cfsiz + MHSIZ))
1395                         ret = -EINVAL;
1396                 else
1397                         ret = bcm_tx_send(msg, ifindex, sk, cfsiz);
1398                 break;
1399
1400         default:
1401                 ret = -EINVAL;
1402                 break;
1403         }
1404
1405         release_sock(sk);
1406
1407         return ret;
1408 }
1409
1410 /*
1411  * notification handler for netdevice status changes
1412  */
1413 static int bcm_notifier(struct notifier_block *nb, unsigned long msg,
1414                         void *ptr)
1415 {
1416         struct net_device *dev = netdev_notifier_info_to_dev(ptr);
1417         struct bcm_sock *bo = container_of(nb, struct bcm_sock, notifier);
1418         struct sock *sk = &bo->sk;
1419         struct bcm_op *op;
1420         int notify_enodev = 0;
1421
1422         if (!net_eq(dev_net(dev), sock_net(sk)))
1423                 return NOTIFY_DONE;
1424
1425         if (dev->type != ARPHRD_CAN)
1426                 return NOTIFY_DONE;
1427
1428         switch (msg) {
1429
1430         case NETDEV_UNREGISTER:
1431                 lock_sock(sk);
1432
1433                 /* remove device specific receive entries */
1434                 list_for_each_entry(op, &bo->rx_ops, list)
1435                         if (op->rx_reg_dev == dev)
1436                                 bcm_rx_unreg(dev, op);
1437
1438                 /* remove device reference, if this is our bound device */
1439                 if (bo->bound && bo->ifindex == dev->ifindex) {
1440                         bo->bound   = 0;
1441                         bo->ifindex = 0;
1442                         notify_enodev = 1;
1443                 }
1444
1445                 release_sock(sk);
1446
1447                 if (notify_enodev) {
1448                         sk->sk_err = ENODEV;
1449                         if (!sock_flag(sk, SOCK_DEAD))
1450                                 sk->sk_error_report(sk);
1451                 }
1452                 break;
1453
1454         case NETDEV_DOWN:
1455                 if (bo->bound && bo->ifindex == dev->ifindex) {
1456                         sk->sk_err = ENETDOWN;
1457                         if (!sock_flag(sk, SOCK_DEAD))
1458                                 sk->sk_error_report(sk);
1459                 }
1460         }
1461
1462         return NOTIFY_DONE;
1463 }
1464
1465 /*
1466  * initial settings for all BCM sockets to be set at socket creation time
1467  */
1468 static int bcm_init(struct sock *sk)
1469 {
1470         struct bcm_sock *bo = bcm_sk(sk);
1471
1472         bo->bound            = 0;
1473         bo->ifindex          = 0;
1474         bo->dropped_usr_msgs = 0;
1475         bo->bcm_proc_read    = NULL;
1476
1477         INIT_LIST_HEAD(&bo->tx_ops);
1478         INIT_LIST_HEAD(&bo->rx_ops);
1479
1480         /* set notifier */
1481         bo->notifier.notifier_call = bcm_notifier;
1482
1483         register_netdevice_notifier(&bo->notifier);
1484
1485         return 0;
1486 }
1487
1488 /*
1489  * standard socket functions
1490  */
1491 static int bcm_release(struct socket *sock)
1492 {
1493         struct sock *sk = sock->sk;
1494         struct net *net = sock_net(sk);
1495         struct bcm_sock *bo;
1496         struct bcm_op *op, *next;
1497
1498         if (sk == NULL)
1499                 return 0;
1500
1501         bo = bcm_sk(sk);
1502
1503         /* remove bcm_ops, timer, rx_unregister(), etc. */
1504
1505         unregister_netdevice_notifier(&bo->notifier);
1506
1507         lock_sock(sk);
1508
1509         list_for_each_entry_safe(op, next, &bo->tx_ops, list)
1510                 bcm_remove_op(op);
1511
1512         list_for_each_entry_safe(op, next, &bo->rx_ops, list) {
1513                 /*
1514                  * Don't care if we're bound or not (due to netdev problems)
1515                  * can_rx_unregister() is always a save thing to do here.
1516                  */
1517                 if (op->ifindex) {
1518                         /*
1519                          * Only remove subscriptions that had not
1520                          * been removed due to NETDEV_UNREGISTER
1521                          * in bcm_notifier()
1522                          */
1523                         if (op->rx_reg_dev) {
1524                                 struct net_device *dev;
1525
1526                                 dev = dev_get_by_index(net, op->ifindex);
1527                                 if (dev) {
1528                                         bcm_rx_unreg(dev, op);
1529                                         dev_put(dev);
1530                                 }
1531                         }
1532                 } else
1533                         can_rx_unregister(net, NULL, op->can_id,
1534                                           REGMASK(op->can_id),
1535                                           bcm_rx_handler, op);
1536
1537                 bcm_remove_op(op);
1538         }
1539
1540         /* remove procfs entry */
1541         if (net->can.bcmproc_dir && bo->bcm_proc_read)
1542                 remove_proc_entry(bo->procname, net->can.bcmproc_dir);
1543
1544         /* remove device reference */
1545         if (bo->bound) {
1546                 bo->bound   = 0;
1547                 bo->ifindex = 0;
1548         }
1549
1550         sock_orphan(sk);
1551         sock->sk = NULL;
1552
1553         release_sock(sk);
1554         sock_put(sk);
1555
1556         return 0;
1557 }
1558
1559 static int bcm_connect(struct socket *sock, struct sockaddr *uaddr, int len,
1560                        int flags)
1561 {
1562         struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
1563         struct sock *sk = sock->sk;
1564         struct bcm_sock *bo = bcm_sk(sk);
1565         struct net *net = sock_net(sk);
1566         int ret = 0;
1567
1568         if (len < sizeof(*addr))
1569                 return -EINVAL;
1570
1571         lock_sock(sk);
1572
1573         if (bo->bound) {
1574                 ret = -EISCONN;
1575                 goto fail;
1576         }
1577
1578         /* bind a device to this socket */
1579         if (addr->can_ifindex) {
1580                 struct net_device *dev;
1581
1582                 dev = dev_get_by_index(net, addr->can_ifindex);
1583                 if (!dev) {
1584                         ret = -ENODEV;
1585                         goto fail;
1586                 }
1587                 if (dev->type != ARPHRD_CAN) {
1588                         dev_put(dev);
1589                         ret = -ENODEV;
1590                         goto fail;
1591                 }
1592
1593                 bo->ifindex = dev->ifindex;
1594                 dev_put(dev);
1595
1596         } else {
1597                 /* no interface reference for ifindex = 0 ('any' CAN device) */
1598                 bo->ifindex = 0;
1599         }
1600
1601         if (net->can.bcmproc_dir) {
1602                 /* unique socket address as filename */
1603                 sprintf(bo->procname, "%lu", sock_i_ino(sk));
1604                 bo->bcm_proc_read = proc_create_data(bo->procname, 0644,
1605                                                      net->can.bcmproc_dir,
1606                                                      &bcm_proc_fops, sk);
1607                 if (!bo->bcm_proc_read) {
1608                         ret = -ENOMEM;
1609                         goto fail;
1610                 }
1611         }
1612
1613         bo->bound = 1;
1614
1615 fail:
1616         release_sock(sk);
1617
1618         return ret;
1619 }
1620
1621 static int bcm_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1622                        int flags)
1623 {
1624         struct sock *sk = sock->sk;
1625         struct sk_buff *skb;
1626         int error = 0;
1627         int noblock;
1628         int err;
1629
1630         noblock =  flags & MSG_DONTWAIT;
1631         flags   &= ~MSG_DONTWAIT;
1632         skb = skb_recv_datagram(sk, flags, noblock, &error);
1633         if (!skb)
1634                 return error;
1635
1636         if (skb->len < size)
1637                 size = skb->len;
1638
1639         err = memcpy_to_msg(msg, skb->data, size);
1640         if (err < 0) {
1641                 skb_free_datagram(sk, skb);
1642                 return err;
1643         }
1644
1645         sock_recv_ts_and_drops(msg, sk, skb);
1646
1647         if (msg->msg_name) {
1648                 __sockaddr_check_size(sizeof(struct sockaddr_can));
1649                 msg->msg_namelen = sizeof(struct sockaddr_can);
1650                 memcpy(msg->msg_name, skb->cb, msg->msg_namelen);
1651         }
1652
1653         skb_free_datagram(sk, skb);
1654
1655         return size;
1656 }
1657
1658 static const struct proto_ops bcm_ops = {
1659         .family        = PF_CAN,
1660         .release       = bcm_release,
1661         .bind          = sock_no_bind,
1662         .connect       = bcm_connect,
1663         .socketpair    = sock_no_socketpair,
1664         .accept        = sock_no_accept,
1665         .getname       = sock_no_getname,
1666         .poll          = datagram_poll,
1667         .ioctl         = can_ioctl,     /* use can_ioctl() from af_can.c */
1668         .listen        = sock_no_listen,
1669         .shutdown      = sock_no_shutdown,
1670         .setsockopt    = sock_no_setsockopt,
1671         .getsockopt    = sock_no_getsockopt,
1672         .sendmsg       = bcm_sendmsg,
1673         .recvmsg       = bcm_recvmsg,
1674         .mmap          = sock_no_mmap,
1675         .sendpage      = sock_no_sendpage,
1676 };
1677
1678 static struct proto bcm_proto __read_mostly = {
1679         .name       = "CAN_BCM",
1680         .owner      = THIS_MODULE,
1681         .obj_size   = sizeof(struct bcm_sock),
1682         .init       = bcm_init,
1683 };
1684
1685 static const struct can_proto bcm_can_proto = {
1686         .type       = SOCK_DGRAM,
1687         .protocol   = CAN_BCM,
1688         .ops        = &bcm_ops,
1689         .prot       = &bcm_proto,
1690 };
1691
1692 static int canbcm_pernet_init(struct net *net)
1693 {
1694         /* create /proc/net/can-bcm directory */
1695         if (IS_ENABLED(CONFIG_PROC_FS)) {
1696                 net->can.bcmproc_dir =
1697                         proc_net_mkdir(net, "can-bcm", net->proc_net);
1698         }
1699
1700         return 0;
1701 }
1702
1703 static void canbcm_pernet_exit(struct net *net)
1704 {
1705         /* remove /proc/net/can-bcm directory */
1706         if (IS_ENABLED(CONFIG_PROC_FS)) {
1707                 if (net->can.bcmproc_dir)
1708                         remove_proc_entry("can-bcm", net->proc_net);
1709         }
1710 }
1711
1712 static struct pernet_operations canbcm_pernet_ops __read_mostly = {
1713         .init = canbcm_pernet_init,
1714         .exit = canbcm_pernet_exit,
1715 };
1716
1717 static int __init bcm_module_init(void)
1718 {
1719         int err;
1720
1721         pr_info("can: broadcast manager protocol (rev " CAN_BCM_VERSION " t)\n");
1722
1723         err = can_proto_register(&bcm_can_proto);
1724         if (err < 0) {
1725                 printk(KERN_ERR "can: registration of bcm protocol failed\n");
1726                 return err;
1727         }
1728
1729         register_pernet_subsys(&canbcm_pernet_ops);
1730         return 0;
1731 }
1732
1733 static void __exit bcm_module_exit(void)
1734 {
1735         can_proto_unregister(&bcm_can_proto);
1736         unregister_pernet_subsys(&canbcm_pernet_ops);
1737 }
1738
1739 module_init(bcm_module_init);
1740 module_exit(bcm_module_exit);