2 * bcm.c - Broadcast Manager to filter/send (cyclic) CAN content
4 * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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.
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.
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
40 * Send feedback to <socketcan-users@lists.berlios.de>
44 #include <linux/module.h>
45 #include <linux/init.h>
46 #include <linux/hrtimer.h>
47 #include <linux/list.h>
48 #include <linux/proc_fs.h>
49 #include <linux/uio.h>
50 #include <linux/net.h>
51 #include <linux/netdevice.h>
52 #include <linux/socket.h>
53 #include <linux/if_arp.h>
54 #include <linux/skbuff.h>
55 #include <linux/can.h>
56 #include <linux/can/core.h>
57 #include <linux/can/bcm.h>
59 #include <net/net_namespace.h>
61 /* use of last_frames[index].can_dlc */
62 #define RX_RECV 0x40 /* received data for this element */
63 #define RX_THR 0x80 /* element not been sent due to throttle feature */
64 #define BCM_CAN_DLC_MASK 0x0F /* clean private flags in can_dlc by masking */
66 /* get best masking value for can_rx_register() for a given single can_id */
67 #define REGMASK(id) ((id & CAN_EFF_FLAG) ? \
68 (CAN_EFF_MASK | CAN_EFF_FLAG | CAN_RTR_FLAG) : \
69 (CAN_SFF_MASK | CAN_EFF_FLAG | CAN_RTR_FLAG))
71 #define CAN_BCM_VERSION CAN_VERSION
72 static __initdata const char banner[] = KERN_INFO
73 "can: broadcast manager protocol (rev " CAN_BCM_VERSION " t)\n";
75 MODULE_DESCRIPTION("PF_CAN broadcast manager protocol");
76 MODULE_LICENSE("Dual BSD/GPL");
77 MODULE_AUTHOR("Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");
79 /* easy access to can_frame payload */
80 static inline u64 GET_U64(const struct can_frame *cp)
82 return *(u64 *)cp->data;
86 struct list_head list;
90 unsigned long frames_abs, frames_filtered;
91 struct timeval ival1, ival2;
92 struct hrtimer timer, thrtimer;
93 struct tasklet_struct tsklet, thrtsklet;
94 ktime_t rx_stamp, kt_ival1, kt_ival2, kt_lastmsg;
99 struct can_frame *frames;
100 struct can_frame *last_frames;
101 struct can_frame sframe;
102 struct can_frame last_sframe;
104 struct net_device *rx_reg_dev;
107 static struct proc_dir_entry *proc_dir;
113 struct notifier_block notifier;
114 struct list_head rx_ops;
115 struct list_head tx_ops;
116 unsigned long dropped_usr_msgs;
117 struct proc_dir_entry *bcm_proc_read;
118 char procname [9]; /* pointer printed in ASCII with \0 */
121 static inline struct bcm_sock *bcm_sk(const struct sock *sk)
123 return (struct bcm_sock *)sk;
126 #define CFSIZ sizeof(struct can_frame)
127 #define OPSIZ sizeof(struct bcm_op)
128 #define MHSIZ sizeof(struct bcm_msg_head)
133 static char *bcm_proc_getifname(int ifindex)
135 struct net_device *dev;
140 /* no usage counting */
141 dev = __dev_get_by_index(&init_net, ifindex);
148 static int bcm_read_proc(char *page, char **start, off_t off,
149 int count, int *eof, void *data)
152 struct sock *sk = (struct sock *)data;
153 struct bcm_sock *bo = bcm_sk(sk);
156 len += snprintf(page + len, PAGE_SIZE - len, ">>> socket %p",
158 len += snprintf(page + len, PAGE_SIZE - len, " / sk %p", sk);
159 len += snprintf(page + len, PAGE_SIZE - len, " / bo %p", bo);
160 len += snprintf(page + len, PAGE_SIZE - len, " / dropped %lu",
161 bo->dropped_usr_msgs);
162 len += snprintf(page + len, PAGE_SIZE - len, " / bound %s",
163 bcm_proc_getifname(bo->ifindex));
164 len += snprintf(page + len, PAGE_SIZE - len, " <<<\n");
166 list_for_each_entry(op, &bo->rx_ops, list) {
168 unsigned long reduction;
170 /* print only active entries & prevent division by zero */
174 len += snprintf(page + len, PAGE_SIZE - len,
176 op->can_id, bcm_proc_getifname(op->ifindex));
177 len += snprintf(page + len, PAGE_SIZE - len, "[%d]%c ",
179 (op->flags & RX_CHECK_DLC)?'d':' ');
180 if (op->kt_ival1.tv64)
181 len += snprintf(page + len, PAGE_SIZE - len,
184 ktime_to_us(op->kt_ival1));
186 if (op->kt_ival2.tv64)
187 len += snprintf(page + len, PAGE_SIZE - len,
190 ktime_to_us(op->kt_ival2));
192 len += snprintf(page + len, PAGE_SIZE - len,
193 "# recv %ld (%ld) => reduction: ",
194 op->frames_filtered, op->frames_abs);
196 reduction = 100 - (op->frames_filtered * 100) / op->frames_abs;
198 len += snprintf(page + len, PAGE_SIZE - len, "%s%ld%%\n",
199 (reduction == 100)?"near ":"", reduction);
201 if (len > PAGE_SIZE - 200) {
202 /* mark output cut off */
203 len += snprintf(page + len, PAGE_SIZE - len, "(..)\n");
208 list_for_each_entry(op, &bo->tx_ops, list) {
210 len += snprintf(page + len, PAGE_SIZE - len,
211 "tx_op: %03X %s [%d] ",
212 op->can_id, bcm_proc_getifname(op->ifindex),
215 if (op->kt_ival1.tv64)
216 len += snprintf(page + len, PAGE_SIZE - len, "t1=%lld ",
217 (long long) ktime_to_us(op->kt_ival1));
219 if (op->kt_ival2.tv64)
220 len += snprintf(page + len, PAGE_SIZE - len, "t2=%lld ",
221 (long long) ktime_to_us(op->kt_ival2));
223 len += snprintf(page + len, PAGE_SIZE - len, "# sent %ld\n",
226 if (len > PAGE_SIZE - 100) {
227 /* mark output cut off */
228 len += snprintf(page + len, PAGE_SIZE - len, "(..)\n");
233 len += snprintf(page + len, PAGE_SIZE - len, "\n");
240 * bcm_can_tx - send the (next) CAN frame to the appropriate CAN interface
241 * of the given bcm tx op
243 static void bcm_can_tx(struct bcm_op *op)
246 struct net_device *dev;
247 struct can_frame *cf = &op->frames[op->currframe];
249 /* no target device? => exit */
253 dev = dev_get_by_index(&init_net, op->ifindex);
255 /* RFC: should this bcm_op remove itself here? */
259 skb = alloc_skb(CFSIZ, gfp_any());
263 memcpy(skb_put(skb, CFSIZ), cf, CFSIZ);
265 /* send with loopback */
270 /* update statistics */
274 /* reached last frame? */
275 if (op->currframe >= op->nframes)
282 * bcm_send_to_user - send a BCM message to the userspace
283 * (consisting of bcm_msg_head + x CAN frames)
285 static void bcm_send_to_user(struct bcm_op *op, struct bcm_msg_head *head,
286 struct can_frame *frames, int has_timestamp)
289 struct can_frame *firstframe;
290 struct sockaddr_can *addr;
291 struct sock *sk = op->sk;
292 int datalen = head->nframes * CFSIZ;
295 skb = alloc_skb(sizeof(*head) + datalen, gfp_any());
299 memcpy(skb_put(skb, sizeof(*head)), head, sizeof(*head));
302 /* can_frames starting here */
303 firstframe = (struct can_frame *)skb_tail_pointer(skb);
305 memcpy(skb_put(skb, datalen), frames, datalen);
308 * the BCM uses the can_dlc-element of the can_frame
309 * structure for internal purposes. This is only
310 * relevant for updates that are generated by the
311 * BCM, where nframes is 1
313 if (head->nframes == 1)
314 firstframe->can_dlc &= BCM_CAN_DLC_MASK;
318 /* restore rx timestamp */
319 skb->tstamp = op->rx_stamp;
323 * Put the datagram to the queue so that bcm_recvmsg() can
324 * get it from there. We need to pass the interface index to
325 * bcm_recvmsg(). We pass a whole struct sockaddr_can in skb->cb
326 * containing the interface index.
329 BUILD_BUG_ON(sizeof(skb->cb) < sizeof(struct sockaddr_can));
330 addr = (struct sockaddr_can *)skb->cb;
331 memset(addr, 0, sizeof(*addr));
332 addr->can_family = AF_CAN;
333 addr->can_ifindex = op->rx_ifindex;
335 err = sock_queue_rcv_skb(sk, skb);
337 struct bcm_sock *bo = bcm_sk(sk);
340 /* don't care about overflows in this statistic */
341 bo->dropped_usr_msgs++;
345 static void bcm_tx_timeout_tsklet(unsigned long data)
347 struct bcm_op *op = (struct bcm_op *)data;
348 struct bcm_msg_head msg_head;
350 /* create notification to user */
351 msg_head.opcode = TX_EXPIRED;
352 msg_head.flags = op->flags;
353 msg_head.count = op->count;
354 msg_head.ival1 = op->ival1;
355 msg_head.ival2 = op->ival2;
356 msg_head.can_id = op->can_id;
357 msg_head.nframes = 0;
359 bcm_send_to_user(op, &msg_head, NULL, 0);
363 * bcm_tx_timeout_handler - performes cyclic CAN frame transmissions
365 static enum hrtimer_restart bcm_tx_timeout_handler(struct hrtimer *hrtimer)
367 struct bcm_op *op = container_of(hrtimer, struct bcm_op, timer);
368 enum hrtimer_restart ret = HRTIMER_NORESTART;
370 if (op->kt_ival1.tv64 && (op->count > 0)) {
373 if (!op->count && (op->flags & TX_COUNTEVT))
374 tasklet_schedule(&op->tsklet);
377 if (op->kt_ival1.tv64 && (op->count > 0)) {
379 /* send (next) frame */
381 hrtimer_forward(hrtimer, ktime_get(), op->kt_ival1);
382 ret = HRTIMER_RESTART;
385 if (op->kt_ival2.tv64) {
387 /* send (next) frame */
389 hrtimer_forward(hrtimer, ktime_get(), op->kt_ival2);
390 ret = HRTIMER_RESTART;
398 * bcm_rx_changed - create a RX_CHANGED notification due to changed content
400 static void bcm_rx_changed(struct bcm_op *op, struct can_frame *data)
402 struct bcm_msg_head head;
404 /* update statistics */
405 op->frames_filtered++;
407 /* prevent statistics overflow */
408 if (op->frames_filtered > ULONG_MAX/100)
409 op->frames_filtered = op->frames_abs = 0;
411 /* this element is not throttled anymore */
412 data->can_dlc &= (BCM_CAN_DLC_MASK|RX_RECV);
414 head.opcode = RX_CHANGED;
415 head.flags = op->flags;
416 head.count = op->count;
417 head.ival1 = op->ival1;
418 head.ival2 = op->ival2;
419 head.can_id = op->can_id;
422 bcm_send_to_user(op, &head, data, 1);
426 * bcm_rx_update_and_send - process a detected relevant receive content change
427 * 1. update the last received data
428 * 2. send a notification to the user (if possible)
430 static void bcm_rx_update_and_send(struct bcm_op *op,
431 struct can_frame *lastdata,
432 const struct can_frame *rxdata)
434 memcpy(lastdata, rxdata, CFSIZ);
436 /* mark as used and throttled by default */
437 lastdata->can_dlc |= (RX_RECV|RX_THR);
439 /* throtteling mode inactive ? */
440 if (!op->kt_ival2.tv64) {
441 /* send RX_CHANGED to the user immediately */
442 bcm_rx_changed(op, lastdata);
446 /* with active throttling timer we are just done here */
447 if (hrtimer_active(&op->thrtimer))
450 /* first receiption with enabled throttling mode */
451 if (!op->kt_lastmsg.tv64)
452 goto rx_changed_settime;
454 /* got a second frame inside a potential throttle period? */
455 if (ktime_us_delta(ktime_get(), op->kt_lastmsg) <
456 ktime_to_us(op->kt_ival2)) {
457 /* do not send the saved data - only start throttle timer */
458 hrtimer_start(&op->thrtimer,
459 ktime_add(op->kt_lastmsg, op->kt_ival2),
464 /* the gap was that big, that throttling was not needed here */
466 bcm_rx_changed(op, lastdata);
467 op->kt_lastmsg = ktime_get();
471 * bcm_rx_cmp_to_index - (bit)compares the currently received data to formerly
472 * received data stored in op->last_frames[]
474 static void bcm_rx_cmp_to_index(struct bcm_op *op, int index,
475 const struct can_frame *rxdata)
478 * no one uses the MSBs of can_dlc for comparation,
479 * so we use it here to detect the first time of reception
482 if (!(op->last_frames[index].can_dlc & RX_RECV)) {
483 /* received data for the first time => send update to user */
484 bcm_rx_update_and_send(op, &op->last_frames[index], rxdata);
488 /* do a real check in can_frame data section */
490 if ((GET_U64(&op->frames[index]) & GET_U64(rxdata)) !=
491 (GET_U64(&op->frames[index]) & GET_U64(&op->last_frames[index]))) {
492 bcm_rx_update_and_send(op, &op->last_frames[index], rxdata);
496 if (op->flags & RX_CHECK_DLC) {
497 /* do a real check in can_frame dlc */
498 if (rxdata->can_dlc != (op->last_frames[index].can_dlc &
500 bcm_rx_update_and_send(op, &op->last_frames[index],
508 * bcm_rx_starttimer - enable timeout monitoring for CAN frame receiption
510 static void bcm_rx_starttimer(struct bcm_op *op)
512 if (op->flags & RX_NO_AUTOTIMER)
515 if (op->kt_ival1.tv64)
516 hrtimer_start(&op->timer, op->kt_ival1, HRTIMER_MODE_REL);
519 static void bcm_rx_timeout_tsklet(unsigned long data)
521 struct bcm_op *op = (struct bcm_op *)data;
522 struct bcm_msg_head msg_head;
524 /* create notification to user */
525 msg_head.opcode = RX_TIMEOUT;
526 msg_head.flags = op->flags;
527 msg_head.count = op->count;
528 msg_head.ival1 = op->ival1;
529 msg_head.ival2 = op->ival2;
530 msg_head.can_id = op->can_id;
531 msg_head.nframes = 0;
533 bcm_send_to_user(op, &msg_head, NULL, 0);
537 * bcm_rx_timeout_handler - when the (cyclic) CAN frame receiption timed out
539 static enum hrtimer_restart bcm_rx_timeout_handler(struct hrtimer *hrtimer)
541 struct bcm_op *op = container_of(hrtimer, struct bcm_op, timer);
543 /* schedule before NET_RX_SOFTIRQ */
544 tasklet_hi_schedule(&op->tsklet);
546 /* no restart of the timer is done here! */
548 /* if user wants to be informed, when cyclic CAN-Messages come back */
549 if ((op->flags & RX_ANNOUNCE_RESUME) && op->last_frames) {
550 /* clear received can_frames to indicate 'nothing received' */
551 memset(op->last_frames, 0, op->nframes * CFSIZ);
554 return HRTIMER_NORESTART;
558 * bcm_rx_do_flush - helper for bcm_rx_thr_flush
560 static inline int bcm_rx_do_flush(struct bcm_op *op, int update, int index)
562 if ((op->last_frames) && (op->last_frames[index].can_dlc & RX_THR)) {
564 bcm_rx_changed(op, &op->last_frames[index]);
571 * bcm_rx_thr_flush - Check for throttled data and send it to the userspace
573 * update == 0 : just check if throttled data is available (any irq context)
574 * update == 1 : check and send throttled data to userspace (soft_irq context)
576 static int bcm_rx_thr_flush(struct bcm_op *op, int update)
580 if (op->nframes > 1) {
583 /* for MUX filter we start at index 1 */
584 for (i = 1; i < op->nframes; i++)
585 updated += bcm_rx_do_flush(op, update, i);
588 /* for RX_FILTER_ID and simple filter */
589 updated += bcm_rx_do_flush(op, update, 0);
595 static void bcm_rx_thr_tsklet(unsigned long data)
597 struct bcm_op *op = (struct bcm_op *)data;
599 /* push the changed data to the userspace */
600 bcm_rx_thr_flush(op, 1);
604 * bcm_rx_thr_handler - the time for blocked content updates is over now:
605 * Check for throttled data and send it to the userspace
607 static enum hrtimer_restart bcm_rx_thr_handler(struct hrtimer *hrtimer)
609 struct bcm_op *op = container_of(hrtimer, struct bcm_op, thrtimer);
611 tasklet_schedule(&op->thrtsklet);
613 if (bcm_rx_thr_flush(op, 0)) {
614 hrtimer_forward(hrtimer, ktime_get(), op->kt_ival2);
615 return HRTIMER_RESTART;
617 /* rearm throttle handling */
618 op->kt_lastmsg = ktime_set(0, 0);
619 return HRTIMER_NORESTART;
624 * bcm_rx_handler - handle a CAN frame receiption
626 static void bcm_rx_handler(struct sk_buff *skb, void *data)
628 struct bcm_op *op = (struct bcm_op *)data;
629 const struct can_frame *rxframe = (struct can_frame *)skb->data;
632 /* disable timeout */
633 hrtimer_cancel(&op->timer);
635 if (op->can_id != rxframe->can_id)
638 /* save rx timestamp */
639 op->rx_stamp = skb->tstamp;
640 /* save originator for recvfrom() */
641 op->rx_ifindex = skb->dev->ifindex;
642 /* update statistics */
645 if (op->flags & RX_RTR_FRAME) {
646 /* send reply for RTR-request (placed in op->frames[0]) */
651 if (op->flags & RX_FILTER_ID) {
652 /* the easiest case */
653 bcm_rx_update_and_send(op, &op->last_frames[0], rxframe);
657 if (op->nframes == 1) {
658 /* simple compare with index 0 */
659 bcm_rx_cmp_to_index(op, 0, rxframe);
663 if (op->nframes > 1) {
667 * find the first multiplex mask that fits.
668 * Remark: The MUX-mask is stored in index 0
671 for (i = 1; i < op->nframes; i++) {
672 if ((GET_U64(&op->frames[0]) & GET_U64(rxframe)) ==
673 (GET_U64(&op->frames[0]) &
674 GET_U64(&op->frames[i]))) {
675 bcm_rx_cmp_to_index(op, i, rxframe);
682 bcm_rx_starttimer(op);
686 * helpers for bcm_op handling: find & delete bcm [rx|tx] op elements
688 static struct bcm_op *bcm_find_op(struct list_head *ops, canid_t can_id,
693 list_for_each_entry(op, ops, list) {
694 if ((op->can_id == can_id) && (op->ifindex == ifindex))
701 static void bcm_remove_op(struct bcm_op *op)
703 hrtimer_cancel(&op->timer);
704 hrtimer_cancel(&op->thrtimer);
707 tasklet_kill(&op->tsklet);
709 if (op->thrtsklet.func)
710 tasklet_kill(&op->thrtsklet);
712 if ((op->frames) && (op->frames != &op->sframe))
715 if ((op->last_frames) && (op->last_frames != &op->last_sframe))
716 kfree(op->last_frames);
723 static void bcm_rx_unreg(struct net_device *dev, struct bcm_op *op)
725 if (op->rx_reg_dev == dev) {
726 can_rx_unregister(dev, op->can_id, REGMASK(op->can_id),
729 /* mark as removed subscription */
730 op->rx_reg_dev = NULL;
732 printk(KERN_ERR "can-bcm: bcm_rx_unreg: registered device "
733 "mismatch %p %p\n", op->rx_reg_dev, dev);
737 * bcm_delete_rx_op - find and remove a rx op (returns number of removed ops)
739 static int bcm_delete_rx_op(struct list_head *ops, canid_t can_id, int ifindex)
741 struct bcm_op *op, *n;
743 list_for_each_entry_safe(op, n, ops, list) {
744 if ((op->can_id == can_id) && (op->ifindex == ifindex)) {
747 * Don't care if we're bound or not (due to netdev
748 * problems) can_rx_unregister() is always a save
753 * Only remove subscriptions that had not
754 * been removed due to NETDEV_UNREGISTER
757 if (op->rx_reg_dev) {
758 struct net_device *dev;
760 dev = dev_get_by_index(&init_net,
763 bcm_rx_unreg(dev, op);
768 can_rx_unregister(NULL, op->can_id,
778 return 0; /* not found */
782 * bcm_delete_tx_op - find and remove a tx op (returns number of removed ops)
784 static int bcm_delete_tx_op(struct list_head *ops, canid_t can_id, int ifindex)
786 struct bcm_op *op, *n;
788 list_for_each_entry_safe(op, n, ops, list) {
789 if ((op->can_id == can_id) && (op->ifindex == ifindex)) {
796 return 0; /* not found */
800 * bcm_read_op - read out a bcm_op and send it to the user (for bcm_sendmsg)
802 static int bcm_read_op(struct list_head *ops, struct bcm_msg_head *msg_head,
805 struct bcm_op *op = bcm_find_op(ops, msg_head->can_id, ifindex);
810 /* put current values into msg_head */
811 msg_head->flags = op->flags;
812 msg_head->count = op->count;
813 msg_head->ival1 = op->ival1;
814 msg_head->ival2 = op->ival2;
815 msg_head->nframes = op->nframes;
817 bcm_send_to_user(op, msg_head, op->frames, 0);
823 * bcm_tx_setup - create or update a bcm tx op (for bcm_sendmsg)
825 static int bcm_tx_setup(struct bcm_msg_head *msg_head, struct msghdr *msg,
826 int ifindex, struct sock *sk)
828 struct bcm_sock *bo = bcm_sk(sk);
832 /* we need a real device to send frames */
836 /* we need at least one can_frame */
837 if (msg_head->nframes < 1)
840 /* check the given can_id */
841 op = bcm_find_op(&bo->tx_ops, msg_head->can_id, ifindex);
844 /* update existing BCM operation */
847 * Do we need more space for the can_frames than currently
848 * allocated? -> This is a _really_ unusual use-case and
849 * therefore (complexity / locking) it is not supported.
851 if (msg_head->nframes > op->nframes)
854 /* update can_frames content */
855 for (i = 0; i < msg_head->nframes; i++) {
856 err = memcpy_fromiovec((u8 *)&op->frames[i],
857 msg->msg_iov, CFSIZ);
859 if (op->frames[i].can_dlc > 8)
865 if (msg_head->flags & TX_CP_CAN_ID) {
866 /* copy can_id into frame */
867 op->frames[i].can_id = msg_head->can_id;
872 /* insert new BCM operation for the given can_id */
874 op = kzalloc(OPSIZ, GFP_KERNEL);
878 op->can_id = msg_head->can_id;
880 /* create array for can_frames and copy the data */
881 if (msg_head->nframes > 1) {
882 op->frames = kmalloc(msg_head->nframes * CFSIZ,
889 op->frames = &op->sframe;
891 for (i = 0; i < msg_head->nframes; i++) {
892 err = memcpy_fromiovec((u8 *)&op->frames[i],
893 msg->msg_iov, CFSIZ);
895 if (op->frames[i].can_dlc > 8)
899 if (op->frames != &op->sframe)
905 if (msg_head->flags & TX_CP_CAN_ID) {
906 /* copy can_id into frame */
907 op->frames[i].can_id = msg_head->can_id;
911 /* tx_ops never compare with previous received messages */
912 op->last_frames = NULL;
914 /* bcm_can_tx / bcm_tx_timeout_handler needs this */
916 op->ifindex = ifindex;
918 /* initialize uninitialized (kzalloc) structure */
919 hrtimer_init(&op->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
920 op->timer.function = bcm_tx_timeout_handler;
922 /* initialize tasklet for tx countevent notification */
923 tasklet_init(&op->tsklet, bcm_tx_timeout_tsklet,
926 /* currently unused in tx_ops */
927 hrtimer_init(&op->thrtimer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
929 /* add this bcm_op to the list of the tx_ops */
930 list_add(&op->list, &bo->tx_ops);
932 } /* if ((op = bcm_find_op(&bo->tx_ops, msg_head->can_id, ifindex))) */
934 if (op->nframes != msg_head->nframes) {
935 op->nframes = msg_head->nframes;
936 /* start multiple frame transmission with index 0 */
942 op->flags = msg_head->flags;
944 if (op->flags & TX_RESET_MULTI_IDX) {
945 /* start multiple frame transmission with index 0 */
949 if (op->flags & SETTIMER) {
950 /* set timer values */
951 op->count = msg_head->count;
952 op->ival1 = msg_head->ival1;
953 op->ival2 = msg_head->ival2;
954 op->kt_ival1 = timeval_to_ktime(msg_head->ival1);
955 op->kt_ival2 = timeval_to_ktime(msg_head->ival2);
957 /* disable an active timer due to zero values? */
958 if (!op->kt_ival1.tv64 && !op->kt_ival2.tv64)
959 hrtimer_cancel(&op->timer);
962 if ((op->flags & STARTTIMER) &&
963 ((op->kt_ival1.tv64 && op->count) || op->kt_ival2.tv64)) {
965 /* spec: send can_frame when starting timer */
966 op->flags |= TX_ANNOUNCE;
968 if (op->kt_ival1.tv64 && (op->count > 0)) {
969 /* op->count-- is done in bcm_tx_timeout_handler */
970 hrtimer_start(&op->timer, op->kt_ival1,
973 hrtimer_start(&op->timer, op->kt_ival2,
977 if (op->flags & TX_ANNOUNCE)
980 return msg_head->nframes * CFSIZ + MHSIZ;
984 * bcm_rx_setup - create or update a bcm rx op (for bcm_sendmsg)
986 static int bcm_rx_setup(struct bcm_msg_head *msg_head, struct msghdr *msg,
987 int ifindex, struct sock *sk)
989 struct bcm_sock *bo = bcm_sk(sk);
994 if ((msg_head->flags & RX_FILTER_ID) || (!(msg_head->nframes))) {
995 /* be robust against wrong usage ... */
996 msg_head->flags |= RX_FILTER_ID;
997 /* ignore trailing garbage */
998 msg_head->nframes = 0;
1001 if ((msg_head->flags & RX_RTR_FRAME) &&
1002 ((msg_head->nframes != 1) ||
1003 (!(msg_head->can_id & CAN_RTR_FLAG))))
1006 /* check the given can_id */
1007 op = bcm_find_op(&bo->rx_ops, msg_head->can_id, ifindex);
1009 /* update existing BCM operation */
1012 * Do we need more space for the can_frames than currently
1013 * allocated? -> This is a _really_ unusual use-case and
1014 * therefore (complexity / locking) it is not supported.
1016 if (msg_head->nframes > op->nframes)
1019 if (msg_head->nframes) {
1020 /* update can_frames content */
1021 err = memcpy_fromiovec((u8 *)op->frames,
1023 msg_head->nframes * CFSIZ);
1027 /* clear last_frames to indicate 'nothing received' */
1028 memset(op->last_frames, 0, msg_head->nframes * CFSIZ);
1031 op->nframes = msg_head->nframes;
1033 /* Only an update -> do not call can_rx_register() */
1037 /* insert new BCM operation for the given can_id */
1038 op = kzalloc(OPSIZ, GFP_KERNEL);
1042 op->can_id = msg_head->can_id;
1043 op->nframes = msg_head->nframes;
1045 if (msg_head->nframes > 1) {
1046 /* create array for can_frames and copy the data */
1047 op->frames = kmalloc(msg_head->nframes * CFSIZ,
1054 /* create and init array for received can_frames */
1055 op->last_frames = kzalloc(msg_head->nframes * CFSIZ,
1057 if (!op->last_frames) {
1064 op->frames = &op->sframe;
1065 op->last_frames = &op->last_sframe;
1068 if (msg_head->nframes) {
1069 err = memcpy_fromiovec((u8 *)op->frames, msg->msg_iov,
1070 msg_head->nframes * CFSIZ);
1072 if (op->frames != &op->sframe)
1074 if (op->last_frames != &op->last_sframe)
1075 kfree(op->last_frames);
1081 /* bcm_can_tx / bcm_tx_timeout_handler needs this */
1083 op->ifindex = ifindex;
1085 /* initialize uninitialized (kzalloc) structure */
1086 hrtimer_init(&op->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
1087 op->timer.function = bcm_rx_timeout_handler;
1089 /* initialize tasklet for rx timeout notification */
1090 tasklet_init(&op->tsklet, bcm_rx_timeout_tsklet,
1091 (unsigned long) op);
1093 hrtimer_init(&op->thrtimer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
1094 op->thrtimer.function = bcm_rx_thr_handler;
1096 /* initialize tasklet for rx throttle handling */
1097 tasklet_init(&op->thrtsklet, bcm_rx_thr_tsklet,
1098 (unsigned long) op);
1100 /* add this bcm_op to the list of the rx_ops */
1101 list_add(&op->list, &bo->rx_ops);
1103 /* call can_rx_register() */
1106 } /* if ((op = bcm_find_op(&bo->rx_ops, msg_head->can_id, ifindex))) */
1109 op->flags = msg_head->flags;
1111 if (op->flags & RX_RTR_FRAME) {
1113 /* no timers in RTR-mode */
1114 hrtimer_cancel(&op->thrtimer);
1115 hrtimer_cancel(&op->timer);
1118 * funny feature in RX(!)_SETUP only for RTR-mode:
1119 * copy can_id into frame BUT without RTR-flag to
1120 * prevent a full-load-loopback-test ... ;-]
1122 if ((op->flags & TX_CP_CAN_ID) ||
1123 (op->frames[0].can_id == op->can_id))
1124 op->frames[0].can_id = op->can_id & ~CAN_RTR_FLAG;
1127 if (op->flags & SETTIMER) {
1129 /* set timer value */
1130 op->ival1 = msg_head->ival1;
1131 op->ival2 = msg_head->ival2;
1132 op->kt_ival1 = timeval_to_ktime(msg_head->ival1);
1133 op->kt_ival2 = timeval_to_ktime(msg_head->ival2);
1135 /* disable an active timer due to zero value? */
1136 if (!op->kt_ival1.tv64)
1137 hrtimer_cancel(&op->timer);
1140 * In any case cancel the throttle timer, flush
1141 * potentially blocked msgs and reset throttle handling
1143 op->kt_lastmsg = ktime_set(0, 0);
1144 hrtimer_cancel(&op->thrtimer);
1145 bcm_rx_thr_flush(op, 1);
1148 if ((op->flags & STARTTIMER) && op->kt_ival1.tv64)
1149 hrtimer_start(&op->timer, op->kt_ival1,
1153 /* now we can register for can_ids, if we added a new bcm_op */
1154 if (do_rx_register) {
1156 struct net_device *dev;
1158 dev = dev_get_by_index(&init_net, ifindex);
1160 err = can_rx_register(dev, op->can_id,
1161 REGMASK(op->can_id),
1165 op->rx_reg_dev = dev;
1170 err = can_rx_register(NULL, op->can_id,
1171 REGMASK(op->can_id),
1172 bcm_rx_handler, op, "bcm");
1174 /* this bcm rx op is broken -> remove it */
1175 list_del(&op->list);
1181 return msg_head->nframes * CFSIZ + MHSIZ;
1185 * bcm_tx_send - send a single CAN frame to the CAN interface (for bcm_sendmsg)
1187 static int bcm_tx_send(struct msghdr *msg, int ifindex, struct sock *sk)
1189 struct sk_buff *skb;
1190 struct net_device *dev;
1193 /* we need a real device to send frames */
1197 skb = alloc_skb(CFSIZ, GFP_KERNEL);
1202 err = memcpy_fromiovec(skb_put(skb, CFSIZ), msg->msg_iov, CFSIZ);
1208 dev = dev_get_by_index(&init_net, ifindex);
1216 err = can_send(skb, 1); /* send with loopback */
1222 return CFSIZ + MHSIZ;
1226 * bcm_sendmsg - process BCM commands (opcodes) from the userspace
1228 static int bcm_sendmsg(struct kiocb *iocb, struct socket *sock,
1229 struct msghdr *msg, size_t size)
1231 struct sock *sk = sock->sk;
1232 struct bcm_sock *bo = bcm_sk(sk);
1233 int ifindex = bo->ifindex; /* default ifindex for this bcm_op */
1234 struct bcm_msg_head msg_head;
1235 int ret; /* read bytes or error codes as return value */
1240 /* check for valid message length from userspace */
1241 if (size < MHSIZ || (size - MHSIZ) % CFSIZ)
1244 /* check for alternative ifindex for this bcm_op */
1246 if (!ifindex && msg->msg_name) {
1247 /* no bound device as default => check msg_name */
1248 struct sockaddr_can *addr =
1249 (struct sockaddr_can *)msg->msg_name;
1251 if (addr->can_family != AF_CAN)
1254 /* ifindex from sendto() */
1255 ifindex = addr->can_ifindex;
1258 struct net_device *dev;
1260 dev = dev_get_by_index(&init_net, ifindex);
1264 if (dev->type != ARPHRD_CAN) {
1273 /* read message head information */
1275 ret = memcpy_fromiovec((u8 *)&msg_head, msg->msg_iov, MHSIZ);
1281 switch (msg_head.opcode) {
1284 ret = bcm_tx_setup(&msg_head, msg, ifindex, sk);
1288 ret = bcm_rx_setup(&msg_head, msg, ifindex, sk);
1292 if (bcm_delete_tx_op(&bo->tx_ops, msg_head.can_id, ifindex))
1299 if (bcm_delete_rx_op(&bo->rx_ops, msg_head.can_id, ifindex))
1306 /* reuse msg_head for the reply to TX_READ */
1307 msg_head.opcode = TX_STATUS;
1308 ret = bcm_read_op(&bo->tx_ops, &msg_head, ifindex);
1312 /* reuse msg_head for the reply to RX_READ */
1313 msg_head.opcode = RX_STATUS;
1314 ret = bcm_read_op(&bo->rx_ops, &msg_head, ifindex);
1318 /* we need exactly one can_frame behind the msg head */
1319 if ((msg_head.nframes != 1) || (size != CFSIZ + MHSIZ))
1322 ret = bcm_tx_send(msg, ifindex, sk);
1336 * notification handler for netdevice status changes
1338 static int bcm_notifier(struct notifier_block *nb, unsigned long msg,
1341 struct net_device *dev = (struct net_device *)data;
1342 struct bcm_sock *bo = container_of(nb, struct bcm_sock, notifier);
1343 struct sock *sk = &bo->sk;
1345 int notify_enodev = 0;
1347 if (!net_eq(dev_net(dev), &init_net))
1350 if (dev->type != ARPHRD_CAN)
1355 case NETDEV_UNREGISTER:
1358 /* remove device specific receive entries */
1359 list_for_each_entry(op, &bo->rx_ops, list)
1360 if (op->rx_reg_dev == dev)
1361 bcm_rx_unreg(dev, op);
1363 /* remove device reference, if this is our bound device */
1364 if (bo->bound && bo->ifindex == dev->ifindex) {
1372 if (notify_enodev) {
1373 sk->sk_err = ENODEV;
1374 if (!sock_flag(sk, SOCK_DEAD))
1375 sk->sk_error_report(sk);
1380 if (bo->bound && bo->ifindex == dev->ifindex) {
1381 sk->sk_err = ENETDOWN;
1382 if (!sock_flag(sk, SOCK_DEAD))
1383 sk->sk_error_report(sk);
1391 * initial settings for all BCM sockets to be set at socket creation time
1393 static int bcm_init(struct sock *sk)
1395 struct bcm_sock *bo = bcm_sk(sk);
1399 bo->dropped_usr_msgs = 0;
1400 bo->bcm_proc_read = NULL;
1402 INIT_LIST_HEAD(&bo->tx_ops);
1403 INIT_LIST_HEAD(&bo->rx_ops);
1406 bo->notifier.notifier_call = bcm_notifier;
1408 register_netdevice_notifier(&bo->notifier);
1414 * standard socket functions
1416 static int bcm_release(struct socket *sock)
1418 struct sock *sk = sock->sk;
1419 struct bcm_sock *bo = bcm_sk(sk);
1420 struct bcm_op *op, *next;
1422 /* remove bcm_ops, timer, rx_unregister(), etc. */
1424 unregister_netdevice_notifier(&bo->notifier);
1428 list_for_each_entry_safe(op, next, &bo->tx_ops, list)
1431 list_for_each_entry_safe(op, next, &bo->rx_ops, list) {
1433 * Don't care if we're bound or not (due to netdev problems)
1434 * can_rx_unregister() is always a save thing to do here.
1438 * Only remove subscriptions that had not
1439 * been removed due to NETDEV_UNREGISTER
1442 if (op->rx_reg_dev) {
1443 struct net_device *dev;
1445 dev = dev_get_by_index(&init_net, op->ifindex);
1447 bcm_rx_unreg(dev, op);
1452 can_rx_unregister(NULL, op->can_id,
1453 REGMASK(op->can_id),
1454 bcm_rx_handler, op);
1459 /* remove procfs entry */
1460 if (proc_dir && bo->bcm_proc_read)
1461 remove_proc_entry(bo->procname, proc_dir);
1463 /* remove device reference */
1475 static int bcm_connect(struct socket *sock, struct sockaddr *uaddr, int len,
1478 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
1479 struct sock *sk = sock->sk;
1480 struct bcm_sock *bo = bcm_sk(sk);
1485 /* bind a device to this socket */
1486 if (addr->can_ifindex) {
1487 struct net_device *dev;
1489 dev = dev_get_by_index(&init_net, addr->can_ifindex);
1493 if (dev->type != ARPHRD_CAN) {
1498 bo->ifindex = dev->ifindex;
1502 /* no interface reference for ifindex = 0 ('any' CAN device) */
1509 /* unique socket address as filename */
1510 sprintf(bo->procname, "%p", sock);
1511 bo->bcm_proc_read = create_proc_read_entry(bo->procname, 0644,
1519 static int bcm_recvmsg(struct kiocb *iocb, struct socket *sock,
1520 struct msghdr *msg, size_t size, int flags)
1522 struct sock *sk = sock->sk;
1523 struct sk_buff *skb;
1528 noblock = flags & MSG_DONTWAIT;
1529 flags &= ~MSG_DONTWAIT;
1530 skb = skb_recv_datagram(sk, flags, noblock, &error);
1534 if (skb->len < size)
1537 err = memcpy_toiovec(msg->msg_iov, skb->data, size);
1539 skb_free_datagram(sk, skb);
1543 sock_recv_timestamp(msg, sk, skb);
1545 if (msg->msg_name) {
1546 msg->msg_namelen = sizeof(struct sockaddr_can);
1547 memcpy(msg->msg_name, skb->cb, msg->msg_namelen);
1550 skb_free_datagram(sk, skb);
1555 static struct proto_ops bcm_ops __read_mostly = {
1557 .release = bcm_release,
1558 .bind = sock_no_bind,
1559 .connect = bcm_connect,
1560 .socketpair = sock_no_socketpair,
1561 .accept = sock_no_accept,
1562 .getname = sock_no_getname,
1563 .poll = datagram_poll,
1564 .ioctl = NULL, /* use can_ioctl() from af_can.c */
1565 .listen = sock_no_listen,
1566 .shutdown = sock_no_shutdown,
1567 .setsockopt = sock_no_setsockopt,
1568 .getsockopt = sock_no_getsockopt,
1569 .sendmsg = bcm_sendmsg,
1570 .recvmsg = bcm_recvmsg,
1571 .mmap = sock_no_mmap,
1572 .sendpage = sock_no_sendpage,
1575 static struct proto bcm_proto __read_mostly = {
1577 .owner = THIS_MODULE,
1578 .obj_size = sizeof(struct bcm_sock),
1582 static struct can_proto bcm_can_proto __read_mostly = {
1584 .protocol = CAN_BCM,
1590 static int __init bcm_module_init(void)
1596 err = can_proto_register(&bcm_can_proto);
1598 printk(KERN_ERR "can: registration of bcm protocol failed\n");
1602 /* create /proc/net/can-bcm directory */
1603 proc_dir = proc_mkdir("can-bcm", init_net.proc_net);
1606 proc_dir->owner = THIS_MODULE;
1611 static void __exit bcm_module_exit(void)
1613 can_proto_unregister(&bcm_can_proto);
1616 proc_net_remove(&init_net, "can-bcm");
1619 module_init(bcm_module_init);
1620 module_exit(bcm_module_exit);