2 * af_can.c - Protocol family CAN core module
3 * (used by different CAN protocol modules)
5 * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of Volkswagen nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * Alternatively, provided that this notice is retained in full, this
21 * software may be distributed under the terms of the GNU General
22 * Public License ("GPL") version 2, in which case the provisions of the
23 * GPL apply INSTEAD OF those given above.
25 * The provided data structures and external interfaces from this code
26 * are not restricted to be used by modules with a GPL compatible license.
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
41 * Send feedback to <socketcan-users@lists.berlios.de>
45 #include <linux/module.h>
46 #include <linux/init.h>
47 #include <linux/kmod.h>
48 #include <linux/slab.h>
49 #include <linux/list.h>
50 #include <linux/spinlock.h>
51 #include <linux/rcupdate.h>
52 #include <linux/uaccess.h>
53 #include <linux/net.h>
54 #include <linux/netdevice.h>
55 #include <linux/socket.h>
56 #include <linux/if_ether.h>
57 #include <linux/if_arp.h>
58 #include <linux/skbuff.h>
59 #include <linux/can.h>
60 #include <linux/can/core.h>
61 #include <net/net_namespace.h>
66 static __initdata const char banner[] = KERN_INFO
67 "can: controller area network core (" CAN_VERSION_STRING ")\n";
69 MODULE_DESCRIPTION("Controller Area Network PF_CAN core");
70 MODULE_LICENSE("Dual BSD/GPL");
71 MODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>, "
72 "Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");
74 MODULE_ALIAS_NETPROTO(PF_CAN);
76 static int stats_timer __read_mostly = 1;
77 module_param(stats_timer, int, S_IRUGO);
78 MODULE_PARM_DESC(stats_timer, "enable timer for statistics (default:on)");
80 HLIST_HEAD(can_rx_dev_list);
81 static struct dev_rcv_lists can_rx_alldev_list;
82 static DEFINE_SPINLOCK(can_rcvlists_lock);
84 static struct kmem_cache *rcv_cache __read_mostly;
86 /* table of registered CAN protocols */
87 static struct can_proto *proto_tab[CAN_NPROTO] __read_mostly;
88 static DEFINE_SPINLOCK(proto_tab_lock);
90 struct timer_list can_stattimer; /* timer for statistics update */
91 struct s_stats can_stats; /* packet statistics */
92 struct s_pstats can_pstats; /* receive list statistics */
95 * af_can socket functions
98 static int can_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg)
100 struct sock *sk = sock->sk;
105 return sock_get_timestamp(sk, (struct timeval __user *)arg);
112 static void can_sock_destruct(struct sock *sk)
114 skb_queue_purge(&sk->sk_receive_queue);
117 static int can_create(struct net *net, struct socket *sock, int protocol)
120 struct can_proto *cp;
123 sock->state = SS_UNCONNECTED;
125 if (protocol < 0 || protocol >= CAN_NPROTO)
128 if (net != &init_net)
129 return -EAFNOSUPPORT;
131 #ifdef CONFIG_MODULES
132 /* try to load protocol module kernel is modular */
133 if (!proto_tab[protocol]) {
134 err = request_module("can-proto-%d", protocol);
137 * In case of error we only print a message but don't
138 * return the error code immediately. Below we will
139 * return -EPROTONOSUPPORT
141 if (err && printk_ratelimit())
142 printk(KERN_ERR "can: request_module "
143 "(can-proto-%d) failed.\n", protocol);
147 spin_lock(&proto_tab_lock);
148 cp = proto_tab[protocol];
149 if (cp && !try_module_get(cp->prot->owner))
151 spin_unlock(&proto_tab_lock);
153 /* check for available protocol and correct usage */
156 return -EPROTONOSUPPORT;
158 if (cp->type != sock->type) {
159 err = -EPROTONOSUPPORT;
163 if (cp->capability >= 0 && !capable(cp->capability)) {
170 sk = sk_alloc(net, PF_CAN, GFP_KERNEL, cp->prot);
176 sock_init_data(sock, sk);
177 sk->sk_destruct = can_sock_destruct;
179 if (sk->sk_prot->init)
180 err = sk->sk_prot->init(sk);
183 /* release sk on errors */
189 module_put(cp->prot->owner);
198 * can_send - transmit a CAN frame (optional with local loopback)
199 * @skb: pointer to socket buffer with CAN frame in data section
200 * @loop: loopback for listeners on local CAN sockets (recommended default!)
204 * -ENETDOWN when the selected interface is down
205 * -ENOBUFS on full driver queue (see net_xmit_errno())
206 * -ENOMEM when local loopback failed at calling skb_clone()
207 * -EPERM when trying to send on a non-CAN interface
208 * -EINVAL when the skb->data does not contain a valid CAN frame
210 int can_send(struct sk_buff *skb, int loop)
212 struct sk_buff *newskb = NULL;
213 struct can_frame *cf = (struct can_frame *)skb->data;
216 if (skb->len != sizeof(struct can_frame) || cf->can_dlc > 8) {
221 if (skb->dev->type != ARPHRD_CAN) {
226 if (!(skb->dev->flags & IFF_UP)) {
231 skb->protocol = htons(ETH_P_CAN);
232 skb_reset_network_header(skb);
233 skb_reset_transport_header(skb);
236 /* local loopback of sent CAN frames */
238 /* indication for the CAN driver: do loopback */
239 skb->pkt_type = PACKET_LOOPBACK;
242 * The reference to the originating sock may be required
243 * by the receiving socket to check whether the frame is
244 * its own. Example: can_raw sockopt CAN_RAW_RECV_OWN_MSGS
245 * Therefore we have to ensure that skb->sk remains the
246 * reference to the originating sock by restoring skb->sk
247 * after each skb_clone() or skb_orphan() usage.
250 if (!(skb->dev->flags & IFF_ECHO)) {
252 * If the interface is not capable to do loopback
253 * itself, we do it here.
255 newskb = skb_clone(skb, GFP_ATOMIC);
261 newskb->sk = skb->sk;
262 newskb->ip_summed = CHECKSUM_UNNECESSARY;
263 newskb->pkt_type = PACKET_BROADCAST;
266 /* indication for the CAN driver: no loopback required */
267 skb->pkt_type = PACKET_HOST;
270 /* send to netdevice */
271 err = dev_queue_xmit(skb);
273 err = net_xmit_errno(err);
284 /* update statistics */
285 can_stats.tx_frames++;
286 can_stats.tx_frames_delta++;
290 EXPORT_SYMBOL(can_send);
296 static struct dev_rcv_lists *find_dev_rcv_lists(struct net_device *dev)
298 struct dev_rcv_lists *d = NULL;
299 struct hlist_node *n;
302 * find receive list for this device
304 * The hlist_for_each_entry*() macros curse through the list
305 * using the pointer variable n and set d to the containing
306 * struct in each list iteration. Therefore, after list
307 * iteration, d is unmodified when the list is empty, and it
308 * points to last list element, when the list is non-empty
309 * but no match in the loop body is found. I.e. d is *not*
310 * NULL when no match is found. We can, however, use the
311 * cursor variable n to decide if a match was found.
314 hlist_for_each_entry_rcu(d, n, &can_rx_dev_list, list) {
323 * find_rcv_list - determine optimal filterlist inside device filter struct
324 * @can_id: pointer to CAN identifier of a given can_filter
325 * @mask: pointer to CAN mask of a given can_filter
326 * @d: pointer to the device filter struct
329 * Returns the optimal filterlist to reduce the filter handling in the
330 * receive path. This function is called by service functions that need
331 * to register or unregister a can_filter in the filter lists.
333 * A filter matches in general, when
335 * <received_can_id> & mask == can_id & mask
337 * so every bit set in the mask (even CAN_EFF_FLAG, CAN_RTR_FLAG) describe
338 * relevant bits for the filter.
340 * The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
341 * filter for error frames (CAN_ERR_FLAG bit set in mask). For error frames
342 * there is a special filterlist and a special rx path filter handling.
345 * Pointer to optimal filterlist for the given can_id/mask pair.
346 * Constistency checked mask.
347 * Reduced can_id to have a preprocessed filter compare value.
349 static struct hlist_head *find_rcv_list(canid_t *can_id, canid_t *mask,
350 struct dev_rcv_lists *d)
352 canid_t inv = *can_id & CAN_INV_FILTER; /* save flag before masking */
354 /* filter for error frames in extra filterlist */
355 if (*mask & CAN_ERR_FLAG) {
356 /* clear CAN_ERR_FLAG in filter entry */
357 *mask &= CAN_ERR_MASK;
358 return &d->rx[RX_ERR];
361 /* with cleared CAN_ERR_FLAG we have a simple mask/value filterpair */
363 #define CAN_EFF_RTR_FLAGS (CAN_EFF_FLAG | CAN_RTR_FLAG)
365 /* ensure valid values in can_mask for 'SFF only' frame filtering */
366 if ((*mask & CAN_EFF_FLAG) && !(*can_id & CAN_EFF_FLAG))
367 *mask &= (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS);
369 /* reduce condition testing at receive time */
372 /* inverse can_id/can_mask filter */
374 return &d->rx[RX_INV];
376 /* mask == 0 => no condition testing at receive time */
378 return &d->rx[RX_ALL];
380 /* extra filterlists for the subscription of a single non-RTR can_id */
381 if (((*mask & CAN_EFF_RTR_FLAGS) == CAN_EFF_RTR_FLAGS)
382 && !(*can_id & CAN_RTR_FLAG)) {
384 if (*can_id & CAN_EFF_FLAG) {
385 if (*mask == (CAN_EFF_MASK | CAN_EFF_RTR_FLAGS)) {
386 /* RFC: a future use-case for hash-tables? */
387 return &d->rx[RX_EFF];
390 if (*mask == (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS))
391 return &d->rx_sff[*can_id];
395 /* default: filter via can_id/can_mask */
396 return &d->rx[RX_FIL];
400 * can_rx_register - subscribe CAN frames from a specific interface
401 * @dev: pointer to netdevice (NULL => subcribe from 'all' CAN devices list)
402 * @can_id: CAN identifier (see description)
403 * @mask: CAN mask (see description)
404 * @func: callback function on filter match
405 * @data: returned parameter for callback function
406 * @ident: string for calling module indentification
409 * Invokes the callback function with the received sk_buff and the given
410 * parameter 'data' on a matching receive filter. A filter matches, when
412 * <received_can_id> & mask == can_id & mask
414 * The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
415 * filter for error frames (CAN_ERR_FLAG bit set in mask).
417 * The provided pointer to the sk_buff is guaranteed to be valid as long as
418 * the callback function is running. The callback function must *not* free
419 * the given sk_buff while processing it's task. When the given sk_buff is
420 * needed after the end of the callback function it must be cloned inside
421 * the callback function with skb_clone().
425 * -ENOMEM on missing cache mem to create subscription entry
426 * -ENODEV unknown device
428 int can_rx_register(struct net_device *dev, canid_t can_id, canid_t mask,
429 void (*func)(struct sk_buff *, void *), void *data,
433 struct hlist_head *rl;
434 struct dev_rcv_lists *d;
437 /* insert new receiver (dev,canid,mask) -> (func,data) */
439 r = kmem_cache_alloc(rcv_cache, GFP_KERNEL);
443 spin_lock(&can_rcvlists_lock);
445 d = find_dev_rcv_lists(dev);
447 rl = find_rcv_list(&can_id, &mask, d);
456 hlist_add_head_rcu(&r->list, rl);
459 can_pstats.rcv_entries++;
460 if (can_pstats.rcv_entries_max < can_pstats.rcv_entries)
461 can_pstats.rcv_entries_max = can_pstats.rcv_entries;
463 kmem_cache_free(rcv_cache, r);
467 spin_unlock(&can_rcvlists_lock);
471 EXPORT_SYMBOL(can_rx_register);
474 * can_rx_delete_device - rcu callback for dev_rcv_lists structure removal
476 static void can_rx_delete_device(struct rcu_head *rp)
478 struct dev_rcv_lists *d = container_of(rp, struct dev_rcv_lists, rcu);
484 * can_rx_delete_receiver - rcu callback for single receiver entry removal
486 static void can_rx_delete_receiver(struct rcu_head *rp)
488 struct receiver *r = container_of(rp, struct receiver, rcu);
490 kmem_cache_free(rcv_cache, r);
494 * can_rx_unregister - unsubscribe CAN frames from a specific interface
495 * @dev: pointer to netdevice (NULL => unsubcribe from 'all' CAN devices list)
496 * @can_id: CAN identifier
498 * @func: callback function on filter match
499 * @data: returned parameter for callback function
502 * Removes subscription entry depending on given (subscription) values.
504 void can_rx_unregister(struct net_device *dev, canid_t can_id, canid_t mask,
505 void (*func)(struct sk_buff *, void *), void *data)
507 struct receiver *r = NULL;
508 struct hlist_head *rl;
509 struct hlist_node *next;
510 struct dev_rcv_lists *d;
512 spin_lock(&can_rcvlists_lock);
514 d = find_dev_rcv_lists(dev);
516 printk(KERN_ERR "BUG: receive list not found for "
517 "dev %s, id %03X, mask %03X\n",
518 DNAME(dev), can_id, mask);
522 rl = find_rcv_list(&can_id, &mask, d);
525 * Search the receiver list for the item to delete. This should
526 * exist, since no receiver may be unregistered that hasn't
527 * been registered before.
530 hlist_for_each_entry_rcu(r, next, rl, list) {
531 if (r->can_id == can_id && r->mask == mask
532 && r->func == func && r->data == data)
537 * Check for bugs in CAN protocol implementations:
538 * If no matching list item was found, the list cursor variable next
539 * will be NULL, while r will point to the last item of the list.
543 printk(KERN_ERR "BUG: receive list entry not found for "
544 "dev %s, id %03X, mask %03X\n",
545 DNAME(dev), can_id, mask);
551 hlist_del_rcu(&r->list);
554 if (can_pstats.rcv_entries > 0)
555 can_pstats.rcv_entries--;
557 /* remove device structure requested by NETDEV_UNREGISTER */
558 if (d->remove_on_zero_entries && !d->entries)
559 hlist_del_rcu(&d->list);
564 spin_unlock(&can_rcvlists_lock);
566 /* schedule the receiver item for deletion */
568 call_rcu(&r->rcu, can_rx_delete_receiver);
570 /* schedule the device structure for deletion */
572 call_rcu(&d->rcu, can_rx_delete_device);
574 EXPORT_SYMBOL(can_rx_unregister);
576 static inline void deliver(struct sk_buff *skb, struct receiver *r)
578 r->func(skb, r->data);
582 static int can_rcv_filter(struct dev_rcv_lists *d, struct sk_buff *skb)
585 struct hlist_node *n;
587 struct can_frame *cf = (struct can_frame *)skb->data;
588 canid_t can_id = cf->can_id;
593 if (can_id & CAN_ERR_FLAG) {
594 /* check for error frame entries only */
595 hlist_for_each_entry_rcu(r, n, &d->rx[RX_ERR], list) {
596 if (can_id & r->mask) {
604 /* check for unfiltered entries */
605 hlist_for_each_entry_rcu(r, n, &d->rx[RX_ALL], list) {
610 /* check for can_id/mask entries */
611 hlist_for_each_entry_rcu(r, n, &d->rx[RX_FIL], list) {
612 if ((can_id & r->mask) == r->can_id) {
618 /* check for inverted can_id/mask entries */
619 hlist_for_each_entry_rcu(r, n, &d->rx[RX_INV], list) {
620 if ((can_id & r->mask) != r->can_id) {
626 /* check filterlists for single non-RTR can_ids */
627 if (can_id & CAN_RTR_FLAG)
630 if (can_id & CAN_EFF_FLAG) {
631 hlist_for_each_entry_rcu(r, n, &d->rx[RX_EFF], list) {
632 if (r->can_id == can_id) {
638 can_id &= CAN_SFF_MASK;
639 hlist_for_each_entry_rcu(r, n, &d->rx_sff[can_id], list) {
648 static int can_rcv(struct sk_buff *skb, struct net_device *dev,
649 struct packet_type *pt, struct net_device *orig_dev)
651 struct dev_rcv_lists *d;
652 struct can_frame *cf = (struct can_frame *)skb->data;
655 if (dev->type != ARPHRD_CAN || !net_eq(dev_net(dev), &init_net)) {
660 BUG_ON(skb->len != sizeof(struct can_frame) || cf->can_dlc > 8);
662 /* update statistics */
663 can_stats.rx_frames++;
664 can_stats.rx_frames_delta++;
668 /* deliver the packet to sockets listening on all devices */
669 matches = can_rcv_filter(&can_rx_alldev_list, skb);
671 /* find receive list for this device */
672 d = find_dev_rcv_lists(dev);
674 matches += can_rcv_filter(d, skb);
678 /* free the skbuff allocated by the netdevice driver */
683 can_stats.matches_delta++;
690 * af_can protocol functions
694 * can_proto_register - register CAN transport protocol
695 * @cp: pointer to CAN protocol structure
699 * -EINVAL invalid (out of range) protocol number
700 * -EBUSY protocol already in use
701 * -ENOBUF if proto_register() fails
703 int can_proto_register(struct can_proto *cp)
705 int proto = cp->protocol;
708 if (proto < 0 || proto >= CAN_NPROTO) {
709 printk(KERN_ERR "can: protocol number %d out of range\n",
714 err = proto_register(cp->prot, 0);
718 spin_lock(&proto_tab_lock);
719 if (proto_tab[proto]) {
720 printk(KERN_ERR "can: protocol %d already registered\n",
724 proto_tab[proto] = cp;
726 /* use generic ioctl function if not defined by module */
728 cp->ops->ioctl = can_ioctl;
730 spin_unlock(&proto_tab_lock);
733 proto_unregister(cp->prot);
737 EXPORT_SYMBOL(can_proto_register);
740 * can_proto_unregister - unregister CAN transport protocol
741 * @cp: pointer to CAN protocol structure
743 void can_proto_unregister(struct can_proto *cp)
745 int proto = cp->protocol;
747 spin_lock(&proto_tab_lock);
748 if (!proto_tab[proto]) {
749 printk(KERN_ERR "BUG: can: protocol %d is not registered\n",
752 proto_tab[proto] = NULL;
753 spin_unlock(&proto_tab_lock);
755 proto_unregister(cp->prot);
757 EXPORT_SYMBOL(can_proto_unregister);
760 * af_can notifier to create/remove CAN netdevice specific structs
762 static int can_notifier(struct notifier_block *nb, unsigned long msg,
765 struct net_device *dev = (struct net_device *)data;
766 struct dev_rcv_lists *d;
768 if (!net_eq(dev_net(dev), &init_net))
771 if (dev->type != ARPHRD_CAN)
776 case NETDEV_REGISTER:
779 * create new dev_rcv_lists for this device
781 * N.B. zeroing the struct is the correct initialization
782 * for the embedded hlist_head structs.
783 * Another list type, e.g. list_head, would require
784 * explicit initialization.
787 d = kzalloc(sizeof(*d), GFP_KERNEL);
790 "can: allocation of receive list failed\n");
795 spin_lock(&can_rcvlists_lock);
796 hlist_add_head_rcu(&d->list, &can_rx_dev_list);
797 spin_unlock(&can_rcvlists_lock);
801 case NETDEV_UNREGISTER:
802 spin_lock(&can_rcvlists_lock);
804 d = find_dev_rcv_lists(dev);
807 d->remove_on_zero_entries = 1;
810 hlist_del_rcu(&d->list);
812 printk(KERN_ERR "can: notifier: receive list not "
813 "found for dev %s\n", dev->name);
815 spin_unlock(&can_rcvlists_lock);
818 call_rcu(&d->rcu, can_rx_delete_device);
827 * af_can module init/exit functions
830 static struct packet_type can_packet __read_mostly = {
831 .type = __constant_htons(ETH_P_CAN),
836 static struct net_proto_family can_family_ops __read_mostly = {
838 .create = can_create,
839 .owner = THIS_MODULE,
842 /* notifier block for netdevice event */
843 static struct notifier_block can_netdev_notifier __read_mostly = {
844 .notifier_call = can_notifier,
847 static __init int can_init(void)
851 rcv_cache = kmem_cache_create("can_receiver", sizeof(struct receiver),
857 * Insert can_rx_alldev_list for reception on all devices.
858 * This struct is zero initialized which is correct for the
859 * embedded hlist heads, the dev pointer, and the entries counter.
862 spin_lock(&can_rcvlists_lock);
863 hlist_add_head_rcu(&can_rx_alldev_list.list, &can_rx_dev_list);
864 spin_unlock(&can_rcvlists_lock);
867 /* the statistics are updated every second (timer triggered) */
868 setup_timer(&can_stattimer, can_stat_update, 0);
869 mod_timer(&can_stattimer, round_jiffies(jiffies + HZ));
871 can_stattimer.function = NULL;
875 /* protocol register */
876 sock_register(&can_family_ops);
877 register_netdevice_notifier(&can_netdev_notifier);
878 dev_add_pack(&can_packet);
883 static __exit void can_exit(void)
885 struct dev_rcv_lists *d;
886 struct hlist_node *n, *next;
889 del_timer(&can_stattimer);
893 /* protocol unregister */
894 dev_remove_pack(&can_packet);
895 unregister_netdevice_notifier(&can_netdev_notifier);
896 sock_unregister(PF_CAN);
898 /* remove can_rx_dev_list */
899 spin_lock(&can_rcvlists_lock);
900 hlist_del(&can_rx_alldev_list.list);
901 hlist_for_each_entry_safe(d, n, next, &can_rx_dev_list, list) {
905 spin_unlock(&can_rcvlists_lock);
907 kmem_cache_destroy(rcv_cache);
910 module_init(can_init);
911 module_exit(can_exit);