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
;
132 /* try to load protocol module, when CONFIG_KMOD is defined */
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
209 int can_send(struct sk_buff
*skb
, int loop
)
213 if (skb
->dev
->type
!= ARPHRD_CAN
) {
218 if (!(skb
->dev
->flags
& IFF_UP
)) {
223 skb
->protocol
= htons(ETH_P_CAN
);
224 skb_reset_network_header(skb
);
225 skb_reset_transport_header(skb
);
228 /* local loopback of sent CAN frames */
230 /* indication for the CAN driver: do loopback */
231 skb
->pkt_type
= PACKET_LOOPBACK
;
234 * The reference to the originating sock may be required
235 * by the receiving socket to check whether the frame is
236 * its own. Example: can_raw sockopt CAN_RAW_RECV_OWN_MSGS
237 * Therefore we have to ensure that skb->sk remains the
238 * reference to the originating sock by restoring skb->sk
239 * after each skb_clone() or skb_orphan() usage.
242 if (!(skb
->dev
->flags
& IFF_ECHO
)) {
244 * If the interface is not capable to do loopback
245 * itself, we do it here.
247 struct sk_buff
*newskb
= skb_clone(skb
, GFP_ATOMIC
);
254 newskb
->sk
= skb
->sk
;
255 newskb
->ip_summed
= CHECKSUM_UNNECESSARY
;
256 newskb
->pkt_type
= PACKET_BROADCAST
;
260 /* indication for the CAN driver: no loopback required */
261 skb
->pkt_type
= PACKET_HOST
;
264 /* send to netdevice */
265 err
= dev_queue_xmit(skb
);
267 err
= net_xmit_errno(err
);
269 /* update statistics */
270 can_stats
.tx_frames
++;
271 can_stats
.tx_frames_delta
++;
275 EXPORT_SYMBOL(can_send
);
281 static struct dev_rcv_lists
*find_dev_rcv_lists(struct net_device
*dev
)
283 struct dev_rcv_lists
*d
= NULL
;
284 struct hlist_node
*n
;
287 * find receive list for this device
289 * The hlist_for_each_entry*() macros curse through the list
290 * using the pointer variable n and set d to the containing
291 * struct in each list iteration. Therefore, after list
292 * iteration, d is unmodified when the list is empty, and it
293 * points to last list element, when the list is non-empty
294 * but no match in the loop body is found. I.e. d is *not*
295 * NULL when no match is found. We can, however, use the
296 * cursor variable n to decide if a match was found.
299 hlist_for_each_entry_rcu(d
, n
, &can_rx_dev_list
, list
) {
307 static struct hlist_head
*find_rcv_list(canid_t
*can_id
, canid_t
*mask
,
308 struct dev_rcv_lists
*d
)
310 canid_t inv
= *can_id
& CAN_INV_FILTER
; /* save flag before masking */
312 /* filter error frames */
313 if (*mask
& CAN_ERR_FLAG
) {
314 /* clear CAN_ERR_FLAG in list entry */
315 *mask
&= CAN_ERR_MASK
;
316 return &d
->rx
[RX_ERR
];
319 /* ensure valid values in can_mask */
320 if (*mask
& CAN_EFF_FLAG
)
321 *mask
&= (CAN_EFF_MASK
| CAN_EFF_FLAG
| CAN_RTR_FLAG
);
323 *mask
&= (CAN_SFF_MASK
| CAN_RTR_FLAG
);
325 /* reduce condition testing at receive time */
328 /* inverse can_id/can_mask filter */
330 return &d
->rx
[RX_INV
];
332 /* mask == 0 => no condition testing at receive time */
334 return &d
->rx
[RX_ALL
];
336 /* use extra filterset for the subscription of exactly *ONE* can_id */
337 if (*can_id
& CAN_EFF_FLAG
) {
338 if (*mask
== (CAN_EFF_MASK
| CAN_EFF_FLAG
)) {
339 /* RFC: a use-case for hash-tables in the future? */
340 return &d
->rx
[RX_EFF
];
343 if (*mask
== CAN_SFF_MASK
)
344 return &d
->rx_sff
[*can_id
];
347 /* default: filter via can_id/can_mask */
348 return &d
->rx
[RX_FIL
];
352 * can_rx_register - subscribe CAN frames from a specific interface
353 * @dev: pointer to netdevice (NULL => subcribe from 'all' CAN devices list)
354 * @can_id: CAN identifier (see description)
355 * @mask: CAN mask (see description)
356 * @func: callback function on filter match
357 * @data: returned parameter for callback function
358 * @ident: string for calling module indentification
361 * Invokes the callback function with the received sk_buff and the given
362 * parameter 'data' on a matching receive filter. A filter matches, when
364 * <received_can_id> & mask == can_id & mask
366 * The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
367 * filter for error frames (CAN_ERR_FLAG bit set in mask).
371 * -ENOMEM on missing cache mem to create subscription entry
372 * -ENODEV unknown device
374 int can_rx_register(struct net_device
*dev
, canid_t can_id
, canid_t mask
,
375 void (*func
)(struct sk_buff
*, void *), void *data
,
379 struct hlist_head
*rl
;
380 struct dev_rcv_lists
*d
;
383 /* insert new receiver (dev,canid,mask) -> (func,data) */
385 r
= kmem_cache_alloc(rcv_cache
, GFP_KERNEL
);
389 spin_lock(&can_rcvlists_lock
);
391 d
= find_dev_rcv_lists(dev
);
393 rl
= find_rcv_list(&can_id
, &mask
, d
);
402 hlist_add_head_rcu(&r
->list
, rl
);
405 can_pstats
.rcv_entries
++;
406 if (can_pstats
.rcv_entries_max
< can_pstats
.rcv_entries
)
407 can_pstats
.rcv_entries_max
= can_pstats
.rcv_entries
;
409 kmem_cache_free(rcv_cache
, r
);
413 spin_unlock(&can_rcvlists_lock
);
417 EXPORT_SYMBOL(can_rx_register
);
420 * can_rx_delete_device - rcu callback for dev_rcv_lists structure removal
422 static void can_rx_delete_device(struct rcu_head
*rp
)
424 struct dev_rcv_lists
*d
= container_of(rp
, struct dev_rcv_lists
, rcu
);
430 * can_rx_delete_receiver - rcu callback for single receiver entry removal
432 static void can_rx_delete_receiver(struct rcu_head
*rp
)
434 struct receiver
*r
= container_of(rp
, struct receiver
, rcu
);
436 kmem_cache_free(rcv_cache
, r
);
440 * can_rx_unregister - unsubscribe CAN frames from a specific interface
441 * @dev: pointer to netdevice (NULL => unsubcribe from 'all' CAN devices list)
442 * @can_id: CAN identifier
444 * @func: callback function on filter match
445 * @data: returned parameter for callback function
448 * Removes subscription entry depending on given (subscription) values.
450 void can_rx_unregister(struct net_device
*dev
, canid_t can_id
, canid_t mask
,
451 void (*func
)(struct sk_buff
*, void *), void *data
)
453 struct receiver
*r
= NULL
;
454 struct hlist_head
*rl
;
455 struct hlist_node
*next
;
456 struct dev_rcv_lists
*d
;
458 spin_lock(&can_rcvlists_lock
);
460 d
= find_dev_rcv_lists(dev
);
462 printk(KERN_ERR
"BUG: receive list not found for "
463 "dev %s, id %03X, mask %03X\n",
464 DNAME(dev
), can_id
, mask
);
468 rl
= find_rcv_list(&can_id
, &mask
, d
);
471 * Search the receiver list for the item to delete. This should
472 * exist, since no receiver may be unregistered that hasn't
473 * been registered before.
476 hlist_for_each_entry_rcu(r
, next
, rl
, list
) {
477 if (r
->can_id
== can_id
&& r
->mask
== mask
478 && r
->func
== func
&& r
->data
== data
)
483 * Check for bugs in CAN protocol implementations:
484 * If no matching list item was found, the list cursor variable next
485 * will be NULL, while r will point to the last item of the list.
489 printk(KERN_ERR
"BUG: receive list entry not found for "
490 "dev %s, id %03X, mask %03X\n",
491 DNAME(dev
), can_id
, mask
);
497 hlist_del_rcu(&r
->list
);
500 if (can_pstats
.rcv_entries
> 0)
501 can_pstats
.rcv_entries
--;
503 /* remove device structure requested by NETDEV_UNREGISTER */
504 if (d
->remove_on_zero_entries
&& !d
->entries
)
505 hlist_del_rcu(&d
->list
);
510 spin_unlock(&can_rcvlists_lock
);
512 /* schedule the receiver item for deletion */
514 call_rcu(&r
->rcu
, can_rx_delete_receiver
);
516 /* schedule the device structure for deletion */
518 call_rcu(&d
->rcu
, can_rx_delete_device
);
520 EXPORT_SYMBOL(can_rx_unregister
);
522 static inline void deliver(struct sk_buff
*skb
, struct receiver
*r
)
524 struct sk_buff
*clone
= skb_clone(skb
, GFP_ATOMIC
);
528 r
->func(clone
, r
->data
);
533 static int can_rcv_filter(struct dev_rcv_lists
*d
, struct sk_buff
*skb
)
536 struct hlist_node
*n
;
538 struct can_frame
*cf
= (struct can_frame
*)skb
->data
;
539 canid_t can_id
= cf
->can_id
;
544 if (can_id
& CAN_ERR_FLAG
) {
545 /* check for error frame entries only */
546 hlist_for_each_entry_rcu(r
, n
, &d
->rx
[RX_ERR
], list
) {
547 if (can_id
& r
->mask
) {
555 /* check for unfiltered entries */
556 hlist_for_each_entry_rcu(r
, n
, &d
->rx
[RX_ALL
], list
) {
561 /* check for can_id/mask entries */
562 hlist_for_each_entry_rcu(r
, n
, &d
->rx
[RX_FIL
], list
) {
563 if ((can_id
& r
->mask
) == r
->can_id
) {
569 /* check for inverted can_id/mask entries */
570 hlist_for_each_entry_rcu(r
, n
, &d
->rx
[RX_INV
], list
) {
571 if ((can_id
& r
->mask
) != r
->can_id
) {
577 /* check CAN_ID specific entries */
578 if (can_id
& CAN_EFF_FLAG
) {
579 hlist_for_each_entry_rcu(r
, n
, &d
->rx
[RX_EFF
], list
) {
580 if (r
->can_id
== can_id
) {
586 can_id
&= CAN_SFF_MASK
;
587 hlist_for_each_entry_rcu(r
, n
, &d
->rx_sff
[can_id
], list
) {
596 static int can_rcv(struct sk_buff
*skb
, struct net_device
*dev
,
597 struct packet_type
*pt
, struct net_device
*orig_dev
)
599 struct dev_rcv_lists
*d
;
602 if (dev
->type
!= ARPHRD_CAN
|| dev_net(dev
) != &init_net
) {
607 /* update statistics */
608 can_stats
.rx_frames
++;
609 can_stats
.rx_frames_delta
++;
613 /* deliver the packet to sockets listening on all devices */
614 matches
= can_rcv_filter(&can_rx_alldev_list
, skb
);
616 /* find receive list for this device */
617 d
= find_dev_rcv_lists(dev
);
619 matches
+= can_rcv_filter(d
, skb
);
623 /* free the skbuff allocated by the netdevice driver */
628 can_stats
.matches_delta
++;
635 * af_can protocol functions
639 * can_proto_register - register CAN transport protocol
640 * @cp: pointer to CAN protocol structure
644 * -EINVAL invalid (out of range) protocol number
645 * -EBUSY protocol already in use
646 * -ENOBUF if proto_register() fails
648 int can_proto_register(struct can_proto
*cp
)
650 int proto
= cp
->protocol
;
653 if (proto
< 0 || proto
>= CAN_NPROTO
) {
654 printk(KERN_ERR
"can: protocol number %d out of range\n",
659 err
= proto_register(cp
->prot
, 0);
663 spin_lock(&proto_tab_lock
);
664 if (proto_tab
[proto
]) {
665 printk(KERN_ERR
"can: protocol %d already registered\n",
669 proto_tab
[proto
] = cp
;
671 /* use generic ioctl function if not defined by module */
673 cp
->ops
->ioctl
= can_ioctl
;
675 spin_unlock(&proto_tab_lock
);
678 proto_unregister(cp
->prot
);
682 EXPORT_SYMBOL(can_proto_register
);
685 * can_proto_unregister - unregister CAN transport protocol
686 * @cp: pointer to CAN protocol structure
688 void can_proto_unregister(struct can_proto
*cp
)
690 int proto
= cp
->protocol
;
692 spin_lock(&proto_tab_lock
);
693 if (!proto_tab
[proto
]) {
694 printk(KERN_ERR
"BUG: can: protocol %d is not registered\n",
697 proto_tab
[proto
] = NULL
;
698 spin_unlock(&proto_tab_lock
);
700 proto_unregister(cp
->prot
);
702 EXPORT_SYMBOL(can_proto_unregister
);
705 * af_can notifier to create/remove CAN netdevice specific structs
707 static int can_notifier(struct notifier_block
*nb
, unsigned long msg
,
710 struct net_device
*dev
= (struct net_device
*)data
;
711 struct dev_rcv_lists
*d
;
713 if (dev_net(dev
) != &init_net
)
716 if (dev
->type
!= ARPHRD_CAN
)
721 case NETDEV_REGISTER
:
724 * create new dev_rcv_lists for this device
726 * N.B. zeroing the struct is the correct initialization
727 * for the embedded hlist_head structs.
728 * Another list type, e.g. list_head, would require
729 * explicit initialization.
732 d
= kzalloc(sizeof(*d
), GFP_KERNEL
);
735 "can: allocation of receive list failed\n");
740 spin_lock(&can_rcvlists_lock
);
741 hlist_add_head_rcu(&d
->list
, &can_rx_dev_list
);
742 spin_unlock(&can_rcvlists_lock
);
746 case NETDEV_UNREGISTER
:
747 spin_lock(&can_rcvlists_lock
);
749 d
= find_dev_rcv_lists(dev
);
752 d
->remove_on_zero_entries
= 1;
755 hlist_del_rcu(&d
->list
);
757 printk(KERN_ERR
"can: notifier: receive list not "
758 "found for dev %s\n", dev
->name
);
760 spin_unlock(&can_rcvlists_lock
);
763 call_rcu(&d
->rcu
, can_rx_delete_device
);
772 * af_can module init/exit functions
775 static struct packet_type can_packet __read_mostly
= {
776 .type
= __constant_htons(ETH_P_CAN
),
781 static struct net_proto_family can_family_ops __read_mostly
= {
783 .create
= can_create
,
784 .owner
= THIS_MODULE
,
787 /* notifier block for netdevice event */
788 static struct notifier_block can_netdev_notifier __read_mostly
= {
789 .notifier_call
= can_notifier
,
792 static __init
int can_init(void)
796 rcv_cache
= kmem_cache_create("can_receiver", sizeof(struct receiver
),
802 * Insert can_rx_alldev_list for reception on all devices.
803 * This struct is zero initialized which is correct for the
804 * embedded hlist heads, the dev pointer, and the entries counter.
807 spin_lock(&can_rcvlists_lock
);
808 hlist_add_head_rcu(&can_rx_alldev_list
.list
, &can_rx_dev_list
);
809 spin_unlock(&can_rcvlists_lock
);
812 /* the statistics are updated every second (timer triggered) */
813 setup_timer(&can_stattimer
, can_stat_update
, 0);
814 mod_timer(&can_stattimer
, round_jiffies(jiffies
+ HZ
));
816 can_stattimer
.function
= NULL
;
820 /* protocol register */
821 sock_register(&can_family_ops
);
822 register_netdevice_notifier(&can_netdev_notifier
);
823 dev_add_pack(&can_packet
);
828 static __exit
void can_exit(void)
830 struct dev_rcv_lists
*d
;
831 struct hlist_node
*n
, *next
;
834 del_timer(&can_stattimer
);
838 /* protocol unregister */
839 dev_remove_pack(&can_packet
);
840 unregister_netdevice_notifier(&can_netdev_notifier
);
841 sock_unregister(PF_CAN
);
843 /* remove can_rx_dev_list */
844 spin_lock(&can_rcvlists_lock
);
845 hlist_del(&can_rx_alldev_list
.list
);
846 hlist_for_each_entry_safe(d
, n
, next
, &can_rx_dev_list
, list
) {
850 spin_unlock(&can_rcvlists_lock
);
852 kmem_cache_destroy(rcv_cache
);
855 module_init(can_init
);
856 module_exit(can_exit
);