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