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/version.h>
46 #include <linux/init.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>
61 #include <linux/can/version.h> /* for RCSID. Removed by mkpatch script */
64 /* use of last_frames[index].can_dlc */
65 #define RX_RECV 0x40 /* received data for this element */
66 #define RX_THR 0x80 /* element not been sent due to throttle feature */
67 #define BCM_CAN_DLC_MASK 0x0F /* clean private flags in can_dlc by masking */
69 /* get best masking value for can_rx_register() for a given single can_id */
70 #define REGMASK(id) ((id & CAN_EFF_FLAG) ? \
71 (CAN_EFF_MASK | CAN_EFF_FLAG | CAN_RTR_FLAG) : \
72 (CAN_SFF_MASK | CAN_EFF_FLAG | CAN_RTR_FLAG))
74 #define CAN_BCM_VERSION CAN_VERSION
75 static __initdata const char banner[] = KERN_INFO
76 "can: broadcast manager protocol (rev " CAN_BCM_VERSION ")\n";
78 MODULE_DESCRIPTION("PF_CAN broadcast manager protocol");
79 MODULE_LICENSE("Dual BSD/GPL");
80 MODULE_AUTHOR("Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");
81 MODULE_ALIAS("can-proto-2");
83 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,22)
84 #error This code only supports Kernel versions _below_ 2.6.22
85 #error For 2.6.22+ Kernels please use bcm.c instead of bcm-prior-2-6-22.c
88 /* easy access to can_frame payload */
89 static inline u64 GET_U64(const struct can_frame *cp)
91 return *(u64 *)cp->data;
95 struct list_head list;
99 unsigned long frames_abs, frames_filtered;
100 struct timeval ival1, ival2;
101 struct timer_list timer, thrtimer;
102 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,14)
103 struct skb_timeval rx_stamp;
105 struct timeval rx_stamp;
107 unsigned long j_ival1, j_ival2, j_lastmsg;
112 struct can_frame *frames;
113 struct can_frame *last_frames;
114 struct can_frame sframe;
115 struct can_frame last_sframe;
117 struct net_device *rx_reg_dev;
120 static struct proc_dir_entry *proc_dir;
123 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
130 struct notifier_block notifier;
131 struct list_head rx_ops;
132 struct list_head tx_ops;
133 unsigned long dropped_usr_msgs;
134 struct proc_dir_entry *bcm_proc_read;
135 char procname [9]; /* pointer printed in ASCII with \0 */
138 static inline struct bcm_sock *bcm_sk(const struct sock *sk)
140 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
141 return (struct bcm_sock *)sk;
143 return (struct bcm_sock *)sk->sk_protinfo;
147 #define CFSIZ sizeof(struct can_frame)
148 #define OPSIZ sizeof(struct bcm_op)
149 #define MHSIZ sizeof(struct bcm_msg_head)
152 * rounded_tv2jif - calculate jiffies from timeval including optional up
153 * @tv: pointer to timeval
156 * Unlike timeval_to_jiffies() provided in include/linux/jiffies.h, this
157 * function is intentionally more relaxed on precise timer ticks to get
158 * exact one jiffy for requested 1000us on a 1000HZ machine.
159 * This code is to be removed when upgrading to kernel hrtimer.
162 * calculated jiffies (max: ULONG_MAX)
164 static unsigned long rounded_tv2jif(const struct timeval *tv)
166 unsigned long sec = tv->tv_sec;
167 unsigned long usec = tv->tv_usec;
170 if (sec > ULONG_MAX / HZ)
173 /* round up to get at least the requested time */
174 usec += 1000000 / HZ - 1;
176 jif = usec / (1000000 / HZ);
178 if (sec * HZ > ULONG_MAX - jif)
181 return jif + sec * HZ;
187 static char *bcm_proc_getifname(int ifindex)
189 struct net_device *dev;
194 /* no usage counting */
195 dev = __dev_get_by_index(&init_net, ifindex);
202 static int bcm_read_proc(char *page, char **start, off_t off,
203 int count, int *eof, void *data)
206 struct sock *sk = (struct sock *)data;
207 struct bcm_sock *bo = bcm_sk(sk);
210 len += snprintf(page + len, PAGE_SIZE - len, ">>> socket %p",
212 len += snprintf(page + len, PAGE_SIZE - len, " / sk %p", sk);
213 len += snprintf(page + len, PAGE_SIZE - len, " / bo %p", bo);
214 len += snprintf(page + len, PAGE_SIZE - len, " / dropped %lu",
215 bo->dropped_usr_msgs);
216 len += snprintf(page + len, PAGE_SIZE - len, " / bound %s",
217 bcm_proc_getifname(bo->ifindex));
218 len += snprintf(page + len, PAGE_SIZE - len, " <<<\n");
220 list_for_each_entry(op, &bo->rx_ops, list) {
222 unsigned long reduction;
224 /* print only active entries & prevent division by zero */
228 len += snprintf(page + len, PAGE_SIZE - len,
230 op->can_id, bcm_proc_getifname(op->ifindex));
231 len += snprintf(page + len, PAGE_SIZE - len, "[%d]%c ",
233 (op->flags & RX_CHECK_DLC)?'d':' ');
235 len += snprintf(page + len, PAGE_SIZE - len,
236 "timeo=%ld ", op->j_ival1);
239 len += snprintf(page + len, PAGE_SIZE - len,
240 "thr=%ld ", op->j_ival2);
242 len += snprintf(page + len, PAGE_SIZE - len,
243 "# recv %ld (%ld) => reduction: ",
244 op->frames_filtered, op->frames_abs);
246 reduction = 100 - (op->frames_filtered * 100) / op->frames_abs;
248 len += snprintf(page + len, PAGE_SIZE - len, "%s%ld%%\n",
249 (reduction == 100)?"near ":"", reduction);
251 if (len > PAGE_SIZE - 200) {
252 /* mark output cut off */
253 len += snprintf(page + len, PAGE_SIZE - len, "(..)\n");
258 list_for_each_entry(op, &bo->tx_ops, list) {
260 len += snprintf(page + len, PAGE_SIZE - len,
261 "tx_op: %03X %s [%d] ",
262 op->can_id, bcm_proc_getifname(op->ifindex),
266 len += snprintf(page + len, PAGE_SIZE - len, "t1=%ld ",
270 len += snprintf(page + len, PAGE_SIZE - len, "t2=%ld ",
273 len += snprintf(page + len, PAGE_SIZE - len, "# sent %ld\n",
276 if (len > PAGE_SIZE - 100) {
277 /* mark output cut off */
278 len += snprintf(page + len, PAGE_SIZE - len, "(..)\n");
283 len += snprintf(page + len, PAGE_SIZE - len, "\n");
290 * bcm_can_tx - send the (next) CAN frame to the appropriate CAN interface
291 * of the given bcm tx op
293 static void bcm_can_tx(struct bcm_op *op)
296 struct net_device *dev;
297 struct can_frame *cf = &op->frames[op->currframe];
299 /* no target device? => exit */
303 dev = dev_get_by_index(&init_net, op->ifindex);
305 /* RFC: should this bcm_op remove itself here? */
309 skb = alloc_skb(CFSIZ, gfp_any());
313 memcpy(skb_put(skb, CFSIZ), cf, CFSIZ);
315 /* send with loopback */
320 /* update statistics */
324 /* reached last frame? */
325 if (op->currframe >= op->nframes)
332 * bcm_send_to_user - send a BCM message to the userspace
333 * (consisting of bcm_msg_head + x CAN frames)
335 static void bcm_send_to_user(struct bcm_op *op, struct bcm_msg_head *head,
336 struct can_frame *frames, int has_timestamp)
339 struct can_frame *firstframe;
340 struct sockaddr_can *addr;
341 struct sock *sk = op->sk;
342 int datalen = head->nframes * CFSIZ;
345 skb = alloc_skb(sizeof(*head) + datalen, gfp_any());
349 memcpy(skb_put(skb, sizeof(*head)), head, sizeof(*head));
352 /* can_frames starting here */
353 firstframe = (struct can_frame *)skb->tail;
355 memcpy(skb_put(skb, datalen), frames, datalen);
358 * the BCM uses the can_dlc-element of the can_frame
359 * structure for internal purposes. This is only
360 * relevant for updates that are generated by the
361 * BCM, where nframes is 1
363 if (head->nframes == 1)
364 firstframe->can_dlc &= BCM_CAN_DLC_MASK;
368 /* restore rx timestamp */
369 skb->tstamp = op->rx_stamp;
373 * Put the datagram to the queue so that bcm_recvmsg() can
374 * get it from there. We need to pass the interface index to
375 * bcm_recvmsg(). We pass a whole struct sockaddr_can in skb->cb
376 * containing the interface index.
379 BUILD_BUG_ON(sizeof(skb->cb) < sizeof(struct sockaddr_can));
380 addr = (struct sockaddr_can *)skb->cb;
381 memset(addr, 0, sizeof(*addr));
382 addr->can_family = AF_CAN;
383 addr->can_ifindex = op->rx_ifindex;
385 err = sock_queue_rcv_skb(sk, skb);
387 struct bcm_sock *bo = bcm_sk(sk);
390 /* don't care about overflows in this statistic */
391 bo->dropped_usr_msgs++;
396 * bcm_tx_timeout_handler - performes cyclic CAN frame transmissions
398 static void bcm_tx_timeout_handler(unsigned long data)
400 struct bcm_op *op = (struct bcm_op *)data;
401 struct bcm_msg_head msg_head;
403 if (op->j_ival1 && (op->count > 0)) {
406 if (!op->count && (op->flags & TX_COUNTEVT)) {
408 /* create notification to user */
409 msg_head.opcode = TX_EXPIRED;
410 msg_head.flags = op->flags;
411 msg_head.count = op->count;
412 msg_head.ival1 = op->ival1;
413 msg_head.ival2 = op->ival2;
414 msg_head.can_id = op->can_id;
415 msg_head.nframes = 0;
417 bcm_send_to_user(op, &msg_head, NULL, 0);
421 if (op->j_ival1 && (op->count > 0)) {
423 /* send (next) frame */
425 mod_timer(&op->timer, jiffies + op->j_ival1);
430 /* send (next) frame */
432 mod_timer(&op->timer, jiffies + op->j_ival2);
438 * bcm_rx_changed - create a RX_CHANGED notification due to changed content
440 static void bcm_rx_changed(struct bcm_op *op, struct can_frame *data)
442 struct bcm_msg_head head;
444 op->j_lastmsg = jiffies;
446 /* update statistics */
447 op->frames_filtered++;
449 /* prevent statistics overflow */
450 if (op->frames_filtered > ULONG_MAX/100)
451 op->frames_filtered = op->frames_abs = 0;
453 /* this element is not throttled anymore */
454 data->can_dlc &= (BCM_CAN_DLC_MASK|RX_RECV);
456 head.opcode = RX_CHANGED;
457 head.flags = op->flags;
458 head.count = op->count;
459 head.ival1 = op->ival1;
460 head.ival2 = op->ival2;
461 head.can_id = op->can_id;
464 bcm_send_to_user(op, &head, data, 1);
468 * bcm_rx_update_and_send - process a detected relevant receive content change
469 * 1. update the last received data
470 * 2. send a notification to the user (if possible)
472 static void bcm_rx_update_and_send(struct bcm_op *op,
473 struct can_frame *lastdata,
474 const struct can_frame *rxdata)
476 unsigned long nexttx = op->j_lastmsg + op->j_ival2;
478 memcpy(lastdata, rxdata, CFSIZ);
480 /* mark as used and throttled by default */
481 lastdata->can_dlc |= (RX_RECV|RX_THR);
483 /* throttle bcm_rx_changed ? */
484 if ((op->thrtimer.expires) ||
485 ((op->j_ival2) && (nexttx > jiffies))) {
486 /* we are already waiting OR we have to start waiting */
488 if (!(op->thrtimer.expires)) {
489 /* start the timer only the first time */
490 mod_timer(&op->thrtimer, nexttx);
494 /* send RX_CHANGED to the user immediately */
495 bcm_rx_changed(op, lastdata);
500 * bcm_rx_cmp_to_index - (bit)compares the currently received data to formerly
501 * received data stored in op->last_frames[]
503 static void bcm_rx_cmp_to_index(struct bcm_op *op, int index,
504 const struct can_frame *rxdata)
507 * no one uses the MSBs of can_dlc for comparation,
508 * so we use it here to detect the first time of reception
511 if (!(op->last_frames[index].can_dlc & RX_RECV)) {
512 /* received data for the first time => send update to user */
513 bcm_rx_update_and_send(op, &op->last_frames[index], rxdata);
517 /* do a real check in can_frame data section */
519 if ((GET_U64(&op->frames[index]) & GET_U64(rxdata)) !=
520 (GET_U64(&op->frames[index]) & GET_U64(&op->last_frames[index]))) {
521 bcm_rx_update_and_send(op, &op->last_frames[index], rxdata);
525 if (op->flags & RX_CHECK_DLC) {
526 /* do a real check in can_frame dlc */
527 if (rxdata->can_dlc != (op->last_frames[index].can_dlc &
529 bcm_rx_update_and_send(op, &op->last_frames[index],
537 * bcm_rx_starttimer - enable timeout monitoring for CAN frame receiption
539 static void bcm_rx_starttimer(struct bcm_op *op)
541 if (op->flags & RX_NO_AUTOTIMER)
545 mod_timer(&op->timer, jiffies + op->j_ival1);
549 * bcm_rx_timeout_handler - when the (cyclic) CAN frame receiption timed out
551 static void bcm_rx_timeout_handler(unsigned long data)
553 struct bcm_op *op = (struct bcm_op *)data;
554 struct bcm_msg_head msg_head;
556 /* create notification to user */
557 msg_head.opcode = RX_TIMEOUT;
558 msg_head.flags = op->flags;
559 msg_head.count = op->count;
560 msg_head.ival1 = op->ival1;
561 msg_head.ival2 = op->ival2;
562 msg_head.can_id = op->can_id;
563 msg_head.nframes = 0;
565 bcm_send_to_user(op, &msg_head, NULL, 0);
567 /* no restart of the timer is done here! */
569 /* if user wants to be informed, when cyclic CAN-Messages come back */
570 if ((op->flags & RX_ANNOUNCE_RESUME) && op->last_frames) {
571 /* clear received can_frames to indicate 'nothing received' */
572 memset(op->last_frames, 0, op->nframes * CFSIZ);
577 * bcm_rx_do_flush - helper for bcm_rx_thr_flush
579 static inline int bcm_rx_do_flush(struct bcm_op *op, int index)
581 if ((op->last_frames) && (op->last_frames[index].can_dlc & RX_THR)) {
582 bcm_rx_changed(op, &op->last_frames[index]);
589 * bcm_rx_thr_flush - Check for throttled data and send it to the userspace
591 static int bcm_rx_thr_flush(struct bcm_op *op)
595 if (op->nframes > 1) {
598 /* for MUX filter we start at index 1 */
599 for (i = 1; i < op->nframes; i++)
600 updated += bcm_rx_do_flush(op, i);
603 /* for RX_FILTER_ID and simple filter */
604 updated += bcm_rx_do_flush(op, 0);
611 * bcm_rx_thr_handler - the time for blocked content updates is over now:
612 * Check for throttled data and send it to the userspace
614 static void bcm_rx_thr_handler(unsigned long data)
616 struct bcm_op *op = (struct bcm_op *)data;
618 if (bcm_rx_thr_flush(op))
619 mod_timer(&op->thrtimer, jiffies + op->j_ival2);
621 /* mark disabled / consumed timer */
622 op->thrtimer.expires = 0;
627 * bcm_rx_handler - handle a CAN frame receiption
629 static void bcm_rx_handler(struct sk_buff *skb, void *data)
631 struct bcm_op *op = (struct bcm_op *)data;
632 const struct can_frame *rxframe = (struct can_frame *)skb->data;
635 /* disable timeout */
636 del_timer(&op->timer);
638 if (op->can_id != rxframe->can_id)
641 /* save rx timestamp */
642 op->rx_stamp = skb->tstamp;
643 /* save originator for recvfrom() */
644 op->rx_ifindex = skb->dev->ifindex;
645 /* update statistics */
648 if (op->flags & RX_RTR_FRAME) {
649 /* send reply for RTR-request (placed in op->frames[0]) */
654 if (op->flags & RX_FILTER_ID) {
655 /* the easiest case */
656 bcm_rx_update_and_send(op, &op->last_frames[0], rxframe);
660 if (op->nframes == 1) {
661 /* simple compare with index 0 */
662 bcm_rx_cmp_to_index(op, 0, rxframe);
666 if (op->nframes > 1) {
670 * find the first multiplex mask that fits.
671 * Remark: The MUX-mask is stored in index 0
674 for (i = 1; i < op->nframes; i++) {
675 if ((GET_U64(&op->frames[0]) & GET_U64(rxframe)) ==
676 (GET_U64(&op->frames[0]) &
677 GET_U64(&op->frames[i]))) {
678 bcm_rx_cmp_to_index(op, i, rxframe);
685 bcm_rx_starttimer(op);
689 * helpers for bcm_op handling: find & delete bcm [rx|tx] op elements
691 static struct bcm_op *bcm_find_op(struct list_head *ops, canid_t can_id,
696 list_for_each_entry(op, ops, list) {
697 if ((op->can_id == can_id) && (op->ifindex == ifindex))
704 static void bcm_remove_op(struct bcm_op *op)
706 del_timer(&op->timer);
707 del_timer(&op->thrtimer);
709 if ((op->frames) && (op->frames != &op->sframe))
712 if ((op->last_frames) && (op->last_frames != &op->last_sframe))
713 kfree(op->last_frames);
720 static void bcm_rx_unreg(struct net_device *dev, struct bcm_op *op)
722 if (op->rx_reg_dev == dev) {
723 can_rx_unregister(dev, op->can_id, REGMASK(op->can_id),
726 /* mark as removed subscription */
727 op->rx_reg_dev = NULL;
729 printk(KERN_ERR "can-bcm: bcm_rx_unreg: registered device "
730 "mismatch %p %p\n", op->rx_reg_dev, dev);
734 * bcm_delete_rx_op - find and remove a rx op (returns number of removed ops)
736 static int bcm_delete_rx_op(struct list_head *ops, canid_t can_id, int ifindex)
738 struct bcm_op *op, *n;
740 list_for_each_entry_safe(op, n, ops, list) {
741 if ((op->can_id == can_id) && (op->ifindex == ifindex)) {
744 * Don't care if we're bound or not (due to netdev
745 * problems) can_rx_unregister() is always a save
750 * Only remove subscriptions that had not
751 * been removed due to NETDEV_UNREGISTER
754 if (op->rx_reg_dev) {
755 struct net_device *dev;
757 dev = dev_get_by_index(&init_net,
760 bcm_rx_unreg(dev, op);
765 can_rx_unregister(NULL, op->can_id,
775 return 0; /* not found */
779 * bcm_delete_tx_op - find and remove a tx op (returns number of removed ops)
781 static int bcm_delete_tx_op(struct list_head *ops, canid_t can_id, int ifindex)
783 struct bcm_op *op, *n;
785 list_for_each_entry_safe(op, n, ops, list) {
786 if ((op->can_id == can_id) && (op->ifindex == ifindex)) {
793 return 0; /* not found */
797 * bcm_read_op - read out a bcm_op and send it to the user (for bcm_sendmsg)
799 static int bcm_read_op(struct list_head *ops, struct bcm_msg_head *msg_head,
802 struct bcm_op *op = bcm_find_op(ops, msg_head->can_id, ifindex);
807 /* put current values into msg_head */
808 msg_head->flags = op->flags;
809 msg_head->count = op->count;
810 msg_head->ival1 = op->ival1;
811 msg_head->ival2 = op->ival2;
812 msg_head->nframes = op->nframes;
814 bcm_send_to_user(op, msg_head, op->frames, 0);
820 * bcm_tx_setup - create or update a bcm tx op (for bcm_sendmsg)
822 static int bcm_tx_setup(struct bcm_msg_head *msg_head, struct msghdr *msg,
823 int ifindex, struct sock *sk)
825 struct bcm_sock *bo = bcm_sk(sk);
829 /* we need a real device to send frames */
833 /* we need at least one can_frame */
834 if (msg_head->nframes < 1)
837 /* check the given can_id */
838 op = bcm_find_op(&bo->tx_ops, msg_head->can_id, ifindex);
841 /* update existing BCM operation */
844 * Do we need more space for the can_frames than currently
845 * allocated? -> This is a _really_ unusual use-case and
846 * therefore (complexity / locking) it is not supported.
848 if (msg_head->nframes > op->nframes)
851 /* update can_frames content */
852 for (i = 0; i < msg_head->nframes; i++) {
853 err = memcpy_fromiovec((u8 *)&op->frames[i],
854 msg->msg_iov, CFSIZ);
856 if (op->frames[i].can_dlc > 8)
862 if (msg_head->flags & TX_CP_CAN_ID) {
863 /* copy can_id into frame */
864 op->frames[i].can_id = msg_head->can_id;
869 /* insert new BCM operation for the given can_id */
871 op = kzalloc(OPSIZ, GFP_KERNEL);
875 op->can_id = msg_head->can_id;
877 /* create array for can_frames and copy the data */
878 if (msg_head->nframes > 1) {
879 op->frames = kmalloc(msg_head->nframes * CFSIZ,
886 op->frames = &op->sframe;
888 for (i = 0; i < msg_head->nframes; i++) {
889 err = memcpy_fromiovec((u8 *)&op->frames[i],
890 msg->msg_iov, CFSIZ);
892 if (op->frames[i].can_dlc > 8)
896 if (op->frames != &op->sframe)
902 if (msg_head->flags & TX_CP_CAN_ID) {
903 /* copy can_id into frame */
904 op->frames[i].can_id = msg_head->can_id;
908 /* tx_ops never compare with previous received messages */
909 op->last_frames = NULL;
911 /* bcm_can_tx / bcm_tx_timeout_handler needs this */
913 op->ifindex = ifindex;
915 /* initialize uninitialized (kzalloc) structure */
916 setup_timer(&op->timer, bcm_tx_timeout_handler,
919 /* currently unused in tx_ops */
920 init_timer(&op->thrtimer);
922 /* add this bcm_op to the list of the tx_ops */
923 list_add(&op->list, &bo->tx_ops);
925 } /* if ((op = bcm_find_op(&bo->tx_ops, msg_head->can_id, ifindex))) */
927 if (op->nframes != msg_head->nframes) {
928 op->nframes = msg_head->nframes;
929 /* start multiple frame transmission with index 0 */
935 op->flags = msg_head->flags;
937 if (op->flags & TX_RESET_MULTI_IDX) {
938 /* start multiple frame transmission with index 0 */
942 if (op->flags & SETTIMER) {
943 /* set timer values */
944 op->count = msg_head->count;
945 op->ival1 = msg_head->ival1;
946 op->ival2 = msg_head->ival2;
947 op->j_ival1 = rounded_tv2jif(&msg_head->ival1);
948 op->j_ival2 = rounded_tv2jif(&msg_head->ival2);
950 /* disable an active timer due to zero values? */
951 if (!op->j_ival1 && !op->j_ival2)
952 del_timer(&op->timer);
955 if ((op->flags & STARTTIMER) &&
956 ((op->j_ival1 && op->count) || op->j_ival2)) {
958 /* spec: send can_frame when starting timer */
959 op->flags |= TX_ANNOUNCE;
961 if (op->j_ival1 && (op->count > 0)) {
962 /* op->count-- is done in bcm_tx_timeout_handler */
963 mod_timer(&op->timer, jiffies + op->j_ival1);
965 mod_timer(&op->timer, jiffies + op->j_ival2);
968 if (op->flags & TX_ANNOUNCE)
971 return msg_head->nframes * CFSIZ + MHSIZ;
975 * bcm_rx_setup - create or update a bcm rx op (for bcm_sendmsg)
977 static int bcm_rx_setup(struct bcm_msg_head *msg_head, struct msghdr *msg,
978 int ifindex, struct sock *sk)
980 struct bcm_sock *bo = bcm_sk(sk);
985 if ((msg_head->flags & RX_FILTER_ID) || (!(msg_head->nframes))) {
986 /* be robust against wrong usage ... */
987 msg_head->flags |= RX_FILTER_ID;
988 /* ignore trailing garbage */
989 msg_head->nframes = 0;
992 if ((msg_head->flags & RX_RTR_FRAME) &&
993 ((msg_head->nframes != 1) ||
994 (!(msg_head->can_id & CAN_RTR_FLAG))))
997 /* check the given can_id */
998 op = bcm_find_op(&bo->rx_ops, msg_head->can_id, ifindex);
1000 /* update existing BCM operation */
1003 * Do we need more space for the can_frames than currently
1004 * allocated? -> This is a _really_ unusual use-case and
1005 * therefore (complexity / locking) it is not supported.
1007 if (msg_head->nframes > op->nframes)
1010 if (msg_head->nframes) {
1011 /* update can_frames content */
1012 err = memcpy_fromiovec((u8 *)op->frames,
1014 msg_head->nframes * CFSIZ);
1018 /* clear last_frames to indicate 'nothing received' */
1019 memset(op->last_frames, 0, msg_head->nframes * CFSIZ);
1022 op->nframes = msg_head->nframes;
1024 /* Only an update -> do not call can_rx_register() */
1028 /* insert new BCM operation for the given can_id */
1029 op = kzalloc(OPSIZ, GFP_KERNEL);
1033 op->can_id = msg_head->can_id;
1034 op->nframes = msg_head->nframes;
1036 if (msg_head->nframes > 1) {
1037 /* create array for can_frames and copy the data */
1038 op->frames = kmalloc(msg_head->nframes * CFSIZ,
1045 /* create and init array for received can_frames */
1046 op->last_frames = kzalloc(msg_head->nframes * CFSIZ,
1048 if (!op->last_frames) {
1055 op->frames = &op->sframe;
1056 op->last_frames = &op->last_sframe;
1059 if (msg_head->nframes) {
1060 err = memcpy_fromiovec((u8 *)op->frames, msg->msg_iov,
1061 msg_head->nframes * CFSIZ);
1063 if (op->frames != &op->sframe)
1065 if (op->last_frames != &op->last_sframe)
1066 kfree(op->last_frames);
1072 /* bcm_can_tx / bcm_tx_timeout_handler needs this */
1074 op->ifindex = ifindex;
1076 /* initialize uninitialized (kzalloc) structure */
1077 setup_timer(&op->timer, bcm_rx_timeout_handler,
1080 /* init throttle timer for RX_CHANGED */
1081 setup_timer(&op->thrtimer, bcm_rx_thr_handler,
1084 /* mark disabled timer */
1085 op->thrtimer.expires = 0;
1087 /* add this bcm_op to the list of the rx_ops */
1088 list_add(&op->list, &bo->rx_ops);
1090 /* call can_rx_register() */
1093 } /* if ((op = bcm_find_op(&bo->rx_ops, msg_head->can_id, ifindex))) */
1096 op->flags = msg_head->flags;
1098 if (op->flags & RX_RTR_FRAME) {
1100 /* no timers in RTR-mode */
1101 del_timer(&op->thrtimer);
1102 del_timer(&op->timer);
1105 * funny feature in RX(!)_SETUP only for RTR-mode:
1106 * copy can_id into frame BUT without RTR-flag to
1107 * prevent a full-load-loopback-test ... ;-]
1109 if ((op->flags & TX_CP_CAN_ID) ||
1110 (op->frames[0].can_id == op->can_id))
1111 op->frames[0].can_id = op->can_id & ~CAN_RTR_FLAG;
1114 if (op->flags & SETTIMER) {
1116 /* set timer value */
1117 op->ival1 = msg_head->ival1;
1118 op->ival2 = msg_head->ival2;
1119 op->j_ival1 = rounded_tv2jif(&msg_head->ival1);
1120 op->j_ival2 = rounded_tv2jif(&msg_head->ival2);
1122 /* disable an active timer due to zero value? */
1124 del_timer(&op->timer);
1127 * In any case cancel the throttle timer, flush
1128 * potentially blocked msgs and reset throttle handling
1130 del_timer(&op->thrtimer);
1131 bcm_rx_thr_flush(op);
1132 op->thrtimer.expires = 0;
1135 if ((op->flags & STARTTIMER) && op->j_ival1)
1136 mod_timer(&op->timer, jiffies + op->j_ival1);
1139 /* now we can register for can_ids, if we added a new bcm_op */
1140 if (do_rx_register) {
1142 struct net_device *dev;
1144 dev = dev_get_by_index(&init_net, ifindex);
1146 err = can_rx_register(dev, op->can_id,
1147 REGMASK(op->can_id),
1151 op->rx_reg_dev = dev;
1156 err = can_rx_register(NULL, op->can_id,
1157 REGMASK(op->can_id),
1158 bcm_rx_handler, op, "bcm");
1160 /* this bcm rx op is broken -> remove it */
1161 list_del(&op->list);
1167 return msg_head->nframes * CFSIZ + MHSIZ;
1171 * bcm_tx_send - send a single CAN frame to the CAN interface (for bcm_sendmsg)
1173 static int bcm_tx_send(struct msghdr *msg, int ifindex, struct sock *sk)
1175 struct sk_buff *skb;
1176 struct net_device *dev;
1179 /* we need a real device to send frames */
1183 skb = alloc_skb(CFSIZ, GFP_KERNEL);
1188 err = memcpy_fromiovec(skb_put(skb, CFSIZ), msg->msg_iov, CFSIZ);
1194 dev = dev_get_by_index(&init_net, ifindex);
1202 err = can_send(skb, 1); /* send with loopback */
1208 return CFSIZ + MHSIZ;
1212 * bcm_sendmsg - process BCM commands (opcodes) from the userspace
1214 static int bcm_sendmsg(struct kiocb *iocb, struct socket *sock,
1215 struct msghdr *msg, size_t size)
1217 struct sock *sk = sock->sk;
1218 struct bcm_sock *bo = bcm_sk(sk);
1219 int ifindex = bo->ifindex; /* default ifindex for this bcm_op */
1220 struct bcm_msg_head msg_head;
1221 int ret; /* read bytes or error codes as return value */
1226 /* check for valid message length from userspace */
1227 if (size < MHSIZ || (size - MHSIZ) % CFSIZ)
1230 /* check for alternative ifindex for this bcm_op */
1232 if (!ifindex && msg->msg_name) {
1233 /* no bound device as default => check msg_name */
1234 struct sockaddr_can *addr =
1235 (struct sockaddr_can *)msg->msg_name;
1237 if (addr->can_family != AF_CAN)
1240 /* ifindex from sendto() */
1241 ifindex = addr->can_ifindex;
1244 struct net_device *dev;
1246 dev = dev_get_by_index(&init_net, ifindex);
1250 if (dev->type != ARPHRD_CAN) {
1259 /* read message head information */
1261 ret = memcpy_fromiovec((u8 *)&msg_head, msg->msg_iov, MHSIZ);
1267 switch (msg_head.opcode) {
1270 ret = bcm_tx_setup(&msg_head, msg, ifindex, sk);
1274 ret = bcm_rx_setup(&msg_head, msg, ifindex, sk);
1278 if (bcm_delete_tx_op(&bo->tx_ops, msg_head.can_id, ifindex))
1285 if (bcm_delete_rx_op(&bo->rx_ops, msg_head.can_id, ifindex))
1292 /* reuse msg_head for the reply to TX_READ */
1293 msg_head.opcode = TX_STATUS;
1294 ret = bcm_read_op(&bo->tx_ops, &msg_head, ifindex);
1298 /* reuse msg_head for the reply to RX_READ */
1299 msg_head.opcode = RX_STATUS;
1300 ret = bcm_read_op(&bo->rx_ops, &msg_head, ifindex);
1304 /* we need exactly one can_frame behind the msg head */
1305 if ((msg_head.nframes != 1) || (size != CFSIZ + MHSIZ))
1308 ret = bcm_tx_send(msg, ifindex, sk);
1322 * notification handler for netdevice status changes
1324 static int bcm_notifier(struct notifier_block *nb, unsigned long msg,
1327 struct net_device *dev = (struct net_device *)data;
1328 struct bcm_sock *bo = container_of(nb, struct bcm_sock, notifier);
1329 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
1330 struct sock *sk = &bo->sk;
1332 struct sock *sk = bo->sk;
1335 int notify_enodev = 0;
1337 if (dev->type != ARPHRD_CAN)
1342 case NETDEV_UNREGISTER:
1345 /* remove device specific receive entries */
1346 list_for_each_entry(op, &bo->rx_ops, list)
1347 if (op->rx_reg_dev == dev)
1348 bcm_rx_unreg(dev, op);
1350 /* remove device reference, if this is our bound device */
1351 if (bo->bound && bo->ifindex == dev->ifindex) {
1359 if (notify_enodev) {
1360 sk->sk_err = ENODEV;
1361 if (!sock_flag(sk, SOCK_DEAD))
1362 sk->sk_error_report(sk);
1367 if (bo->bound && bo->ifindex == dev->ifindex) {
1368 sk->sk_err = ENETDOWN;
1369 if (!sock_flag(sk, SOCK_DEAD))
1370 sk->sk_error_report(sk);
1378 * initial settings for all BCM sockets to be set at socket creation time
1380 static int bcm_init(struct sock *sk)
1382 struct bcm_sock *bo = bcm_sk(sk);
1384 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,12)
1389 bo->dropped_usr_msgs = 0;
1390 bo->bcm_proc_read = NULL;
1392 INIT_LIST_HEAD(&bo->tx_ops);
1393 INIT_LIST_HEAD(&bo->rx_ops);
1396 bo->notifier.notifier_call = bcm_notifier;
1398 register_netdevice_notifier(&bo->notifier);
1404 * standard socket functions
1406 static int bcm_release(struct socket *sock)
1408 struct sock *sk = sock->sk;
1409 struct bcm_sock *bo = bcm_sk(sk);
1410 struct bcm_op *op, *next;
1412 /* remove bcm_ops, timer, rx_unregister(), etc. */
1414 unregister_netdevice_notifier(&bo->notifier);
1418 list_for_each_entry_safe(op, next, &bo->tx_ops, list)
1421 list_for_each_entry_safe(op, next, &bo->rx_ops, list) {
1423 * Don't care if we're bound or not (due to netdev problems)
1424 * can_rx_unregister() is always a save thing to do here.
1428 * Only remove subscriptions that had not
1429 * been removed due to NETDEV_UNREGISTER
1432 if (op->rx_reg_dev) {
1433 struct net_device *dev;
1435 dev = dev_get_by_index(&init_net, op->ifindex);
1437 bcm_rx_unreg(dev, op);
1442 can_rx_unregister(NULL, op->can_id,
1443 REGMASK(op->can_id),
1444 bcm_rx_handler, op);
1449 /* remove procfs entry */
1450 if (proc_dir && bo->bcm_proc_read)
1451 remove_proc_entry(bo->procname, proc_dir);
1453 /* remove device reference */
1465 static int bcm_connect(struct socket *sock, struct sockaddr *uaddr, int len,
1468 struct sockaddr_can *addr = (struct sockaddr_can *)uaddr;
1469 struct sock *sk = sock->sk;
1470 struct bcm_sock *bo = bcm_sk(sk);
1475 /* bind a device to this socket */
1476 if (addr->can_ifindex) {
1477 struct net_device *dev;
1479 dev = dev_get_by_index(&init_net, addr->can_ifindex);
1483 if (dev->type != ARPHRD_CAN) {
1488 bo->ifindex = dev->ifindex;
1492 /* no interface reference for ifindex = 0 ('any' CAN device) */
1499 /* unique socket address as filename */
1500 sprintf(bo->procname, "%p", sock);
1501 bo->bcm_proc_read = create_proc_read_entry(bo->procname, 0644,
1509 static int bcm_recvmsg(struct kiocb *iocb, struct socket *sock,
1510 struct msghdr *msg, size_t size, int flags)
1512 struct sock *sk = sock->sk;
1513 struct sk_buff *skb;
1518 noblock = flags & MSG_DONTWAIT;
1519 flags &= ~MSG_DONTWAIT;
1520 skb = skb_recv_datagram(sk, flags, noblock, &error);
1524 if (skb->len < size)
1527 err = memcpy_toiovec(msg->msg_iov, skb->data, size);
1529 skb_free_datagram(sk, skb);
1533 sock_recv_timestamp(msg, sk, skb);
1535 if (msg->msg_name) {
1536 msg->msg_namelen = sizeof(struct sockaddr_can);
1537 memcpy(msg->msg_name, skb->cb, msg->msg_namelen);
1540 skb_free_datagram(sk, skb);
1545 static struct proto_ops bcm_ops __read_mostly = {
1547 .release = bcm_release,
1548 .bind = sock_no_bind,
1549 .connect = bcm_connect,
1550 .socketpair = sock_no_socketpair,
1551 .accept = sock_no_accept,
1552 .getname = sock_no_getname,
1553 .poll = datagram_poll,
1554 .ioctl = NULL, /* use can_ioctl() from af_can.c */
1555 .listen = sock_no_listen,
1556 .shutdown = sock_no_shutdown,
1557 .setsockopt = sock_no_setsockopt,
1558 .getsockopt = sock_no_getsockopt,
1559 .sendmsg = bcm_sendmsg,
1560 .recvmsg = bcm_recvmsg,
1561 .mmap = sock_no_mmap,
1562 .sendpage = sock_no_sendpage,
1565 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,12)
1566 static struct proto bcm_proto __read_mostly = {
1568 .owner = THIS_MODULE,
1569 .obj_size = sizeof(struct bcm_sock),
1573 static struct can_proto bcm_can_proto __read_mostly = {
1575 .protocol = CAN_BCM,
1581 static struct can_proto bcm_can_proto __read_mostly = {
1583 .protocol = CAN_BCM,
1586 .owner = THIS_MODULE,
1587 .obj_size = sizeof(struct bcm_sock),
1592 static int __init bcm_module_init(void)
1598 err = can_proto_register(&bcm_can_proto);
1600 printk(KERN_ERR "can: registration of bcm protocol failed\n");
1604 /* create /proc/net/can-bcm directory */
1605 proc_dir = proc_mkdir("can-bcm", proc_net);
1608 proc_dir->owner = THIS_MODULE;
1613 static void __exit bcm_module_exit(void)
1615 can_proto_unregister(&bcm_can_proto);
1618 proc_net_remove("can-bcm");
1621 module_init(bcm_module_init);
1622 module_exit(bcm_module_exit);