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