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