blob: d249874a366d363edfc94adc47df54dde6bdba0e [file] [log] [blame]
Oliver Hartkopp0d665482007-11-16 15:52:17 -08001/*
2 * af_can.c - Protocol family CAN core module
3 * (used by different CAN protocol modules)
4 *
5 * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
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.
19 *
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.
24 *
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.
27 *
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
39 * DAMAGE.
40 *
Oliver Hartkopp0d665482007-11-16 15:52:17 -080041 */
42
43#include <linux/module.h>
Oliver Hartkopp7c941632012-06-13 20:04:33 +020044#include <linux/stddef.h>
Oliver Hartkopp0d665482007-11-16 15:52:17 -080045#include <linux/init.h>
46#include <linux/kmod.h>
47#include <linux/slab.h>
48#include <linux/list.h>
49#include <linux/spinlock.h>
50#include <linux/rcupdate.h>
51#include <linux/uaccess.h>
52#include <linux/net.h>
53#include <linux/netdevice.h>
54#include <linux/socket.h>
55#include <linux/if_ether.h>
56#include <linux/if_arp.h>
57#include <linux/skbuff.h>
58#include <linux/can.h>
59#include <linux/can/core.h>
Manuel Zerpiesd751e622011-06-16 02:08:01 +000060#include <linux/ratelimit.h>
Oliver Hartkopp0d665482007-11-16 15:52:17 -080061#include <net/net_namespace.h>
62#include <net/sock.h>
63
64#include "af_can.h"
65
Andi Kleen6299b662012-10-04 17:12:08 -070066static __initconst const char banner[] = KERN_INFO
Oliver Hartkopp0d665482007-11-16 15:52:17 -080067 "can: controller area network core (" CAN_VERSION_STRING ")\n";
68
69MODULE_DESCRIPTION("Controller Area Network PF_CAN core");
70MODULE_LICENSE("Dual BSD/GPL");
71MODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>, "
72 "Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");
73
74MODULE_ALIAS_NETPROTO(PF_CAN);
75
76static int stats_timer __read_mostly = 1;
77module_param(stats_timer, int, S_IRUGO);
78MODULE_PARM_DESC(stats_timer, "enable timer for statistics (default:on)");
79
Oliver Hartkopp20dd3852009-12-25 06:47:47 +000080/* receive filters subscribed for 'all' CAN devices */
81struct dev_rcv_lists can_rx_alldev_list;
Oliver Hartkopp0d665482007-11-16 15:52:17 -080082static DEFINE_SPINLOCK(can_rcvlists_lock);
83
84static struct kmem_cache *rcv_cache __read_mostly;
85
86/* table of registered CAN protocols */
Kurt Van Dijck16506292011-05-03 18:40:57 +000087static const struct can_proto *proto_tab[CAN_NPROTO] __read_mostly;
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +000088static DEFINE_MUTEX(proto_tab_lock);
Oliver Hartkopp0d665482007-11-16 15:52:17 -080089
90struct timer_list can_stattimer; /* timer for statistics update */
91struct s_stats can_stats; /* packet statistics */
92struct s_pstats can_pstats; /* receive list statistics */
93
94/*
95 * af_can socket functions
96 */
97
Oliver Hartkopp53914b62011-03-22 08:27:25 +000098int can_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg)
Oliver Hartkopp0d665482007-11-16 15:52:17 -080099{
100 struct sock *sk = sock->sk;
101
102 switch (cmd) {
103
104 case SIOCGSTAMP:
105 return sock_get_timestamp(sk, (struct timeval __user *)arg);
106
107 default:
108 return -ENOIOCTLCMD;
109 }
110}
Oliver Hartkopp53914b62011-03-22 08:27:25 +0000111EXPORT_SYMBOL(can_ioctl);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800112
113static void can_sock_destruct(struct sock *sk)
114{
115 skb_queue_purge(&sk->sk_receive_queue);
116}
117
Kurt Van Dijckc8d55a92011-05-03 18:42:04 +0000118static const struct can_proto *can_get_proto(int protocol)
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000119{
Kurt Van Dijck16506292011-05-03 18:40:57 +0000120 const struct can_proto *cp;
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000121
122 rcu_read_lock();
123 cp = rcu_dereference(proto_tab[protocol]);
124 if (cp && !try_module_get(cp->prot->owner))
125 cp = NULL;
126 rcu_read_unlock();
127
128 return cp;
129}
130
Kurt Van Dijckc8d55a92011-05-03 18:42:04 +0000131static inline void can_put_proto(const struct can_proto *cp)
132{
133 module_put(cp->prot->owner);
134}
135
Eric Paris3f378b62009-11-05 22:18:14 -0800136static int can_create(struct net *net, struct socket *sock, int protocol,
137 int kern)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800138{
139 struct sock *sk;
Kurt Van Dijck16506292011-05-03 18:40:57 +0000140 const struct can_proto *cp;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800141 int err = 0;
142
143 sock->state = SS_UNCONNECTED;
144
145 if (protocol < 0 || protocol >= CAN_NPROTO)
146 return -EINVAL;
147
Octavian Purdila09ad9bc2009-11-25 15:14:13 -0800148 if (!net_eq(net, &init_net))
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800149 return -EAFNOSUPPORT;
150
Kurt Van Dijckc8d55a92011-05-03 18:42:04 +0000151 cp = can_get_proto(protocol);
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000152
Johannes Berg95a5afc2008-10-16 15:24:51 -0700153#ifdef CONFIG_MODULES
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000154 if (!cp) {
155 /* try to load protocol module if kernel is modular */
156
Urs Thuermann5423dd62008-02-07 18:04:21 -0800157 err = request_module("can-proto-%d", protocol);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800158
159 /*
160 * In case of error we only print a message but don't
161 * return the error code immediately. Below we will
162 * return -EPROTONOSUPPORT
163 */
Manuel Zerpiesd751e622011-06-16 02:08:01 +0000164 if (err)
165 printk_ratelimited(KERN_ERR "can: request_module "
Urs Thuermann5423dd62008-02-07 18:04:21 -0800166 "(can-proto-%d) failed.\n", protocol);
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000167
Kurt Van Dijckc8d55a92011-05-03 18:42:04 +0000168 cp = can_get_proto(protocol);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800169 }
Urs Thuermann5423dd62008-02-07 18:04:21 -0800170#endif
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800171
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800172 /* check for available protocol and correct usage */
173
174 if (!cp)
175 return -EPROTONOSUPPORT;
176
177 if (cp->type != sock->type) {
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000178 err = -EPROTOTYPE;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800179 goto errout;
180 }
181
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800182 sock->ops = cp->ops;
183
184 sk = sk_alloc(net, PF_CAN, GFP_KERNEL, cp->prot);
185 if (!sk) {
186 err = -ENOMEM;
187 goto errout;
188 }
189
190 sock_init_data(sock, sk);
191 sk->sk_destruct = can_sock_destruct;
192
193 if (sk->sk_prot->init)
194 err = sk->sk_prot->init(sk);
195
196 if (err) {
197 /* release sk on errors */
198 sock_orphan(sk);
199 sock_put(sk);
200 }
201
202 errout:
Kurt Van Dijckc8d55a92011-05-03 18:42:04 +0000203 can_put_proto(cp);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800204 return err;
205}
206
207/*
208 * af_can tx path
209 */
210
211/**
212 * can_send - transmit a CAN frame (optional with local loopback)
213 * @skb: pointer to socket buffer with CAN frame in data section
214 * @loop: loopback for listeners on local CAN sockets (recommended default!)
215 *
Oliver Hartkopp481a8192009-09-15 01:31:34 -0700216 * Due to the loopback this routine must not be called from hardirq context.
217 *
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800218 * Return:
219 * 0 on success
220 * -ENETDOWN when the selected interface is down
221 * -ENOBUFS on full driver queue (see net_xmit_errno())
222 * -ENOMEM when local loopback failed at calling skb_clone()
223 * -EPERM when trying to send on a non-CAN interface
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200224 * -EMSGSIZE CAN frame size is bigger than CAN interface MTU
Oliver Hartkopp7f2d38e2008-07-05 23:38:43 -0700225 * -EINVAL when the skb->data does not contain a valid CAN frame
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800226 */
227int can_send(struct sk_buff *skb, int loop)
228{
Oliver Hartkoppc2ab7ac2008-05-08 02:49:55 -0700229 struct sk_buff *newskb = NULL;
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200230 struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
231 int err = -EINVAL;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800232
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200233 if (skb->len == CAN_MTU) {
234 skb->protocol = htons(ETH_P_CAN);
235 if (unlikely(cfd->len > CAN_MAX_DLEN))
236 goto inval_skb;
237 } else if (skb->len == CANFD_MTU) {
238 skb->protocol = htons(ETH_P_CANFD);
239 if (unlikely(cfd->len > CANFD_MAX_DLEN))
240 goto inval_skb;
241 } else
242 goto inval_skb;
243
244 /*
245 * Make sure the CAN frame can pass the selected CAN netdevice.
246 * As structs can_frame and canfd_frame are similar, we can provide
247 * CAN FD frames to legacy CAN drivers as long as the length is <= 8
248 */
249 if (unlikely(skb->len > skb->dev->mtu && cfd->len > CAN_MAX_DLEN)) {
250 err = -EMSGSIZE;
251 goto inval_skb;
Oliver Hartkopp7f2d38e2008-07-05 23:38:43 -0700252 }
253
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200254 if (unlikely(skb->dev->type != ARPHRD_CAN)) {
255 err = -EPERM;
256 goto inval_skb;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800257 }
258
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200259 if (unlikely(!(skb->dev->flags & IFF_UP))) {
260 err = -ENETDOWN;
261 goto inval_skb;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800262 }
263
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800264 skb_reset_network_header(skb);
265 skb_reset_transport_header(skb);
266
267 if (loop) {
268 /* local loopback of sent CAN frames */
269
270 /* indication for the CAN driver: do loopback */
271 skb->pkt_type = PACKET_LOOPBACK;
272
273 /*
274 * The reference to the originating sock may be required
275 * by the receiving socket to check whether the frame is
276 * its own. Example: can_raw sockopt CAN_RAW_RECV_OWN_MSGS
277 * Therefore we have to ensure that skb->sk remains the
278 * reference to the originating sock by restoring skb->sk
279 * after each skb_clone() or skb_orphan() usage.
280 */
281
282 if (!(skb->dev->flags & IFF_ECHO)) {
283 /*
284 * If the interface is not capable to do loopback
285 * itself, we do it here.
286 */
Oliver Hartkoppc2ab7ac2008-05-08 02:49:55 -0700287 newskb = skb_clone(skb, GFP_ATOMIC);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800288 if (!newskb) {
289 kfree_skb(skb);
290 return -ENOMEM;
291 }
292
293 newskb->sk = skb->sk;
294 newskb->ip_summed = CHECKSUM_UNNECESSARY;
295 newskb->pkt_type = PACKET_BROADCAST;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800296 }
297 } else {
298 /* indication for the CAN driver: no loopback required */
299 skb->pkt_type = PACKET_HOST;
300 }
301
302 /* send to netdevice */
303 err = dev_queue_xmit(skb);
304 if (err > 0)
305 err = net_xmit_errno(err);
306
Oliver Hartkoppc2ab7ac2008-05-08 02:49:55 -0700307 if (err) {
Wei Yongjunce030ed2009-02-25 00:35:44 +0000308 kfree_skb(newskb);
Oliver Hartkoppc2ab7ac2008-05-08 02:49:55 -0700309 return err;
310 }
311
312 if (newskb)
Oliver Hartkopp481a8192009-09-15 01:31:34 -0700313 netif_rx_ni(newskb);
Oliver Hartkoppc2ab7ac2008-05-08 02:49:55 -0700314
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800315 /* update statistics */
316 can_stats.tx_frames++;
317 can_stats.tx_frames_delta++;
318
Oliver Hartkoppc2ab7ac2008-05-08 02:49:55 -0700319 return 0;
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200320
321inval_skb:
322 kfree_skb(skb);
323 return err;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800324}
325EXPORT_SYMBOL(can_send);
326
327/*
328 * af_can rx path
329 */
330
331static struct dev_rcv_lists *find_dev_rcv_lists(struct net_device *dev)
332{
Oliver Hartkopp20dd3852009-12-25 06:47:47 +0000333 if (!dev)
334 return &can_rx_alldev_list;
335 else
336 return (struct dev_rcv_lists *)dev->ml_priv;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800337}
338
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800339/**
340 * find_rcv_list - determine optimal filterlist inside device filter struct
341 * @can_id: pointer to CAN identifier of a given can_filter
342 * @mask: pointer to CAN mask of a given can_filter
343 * @d: pointer to the device filter struct
344 *
345 * Description:
346 * Returns the optimal filterlist to reduce the filter handling in the
347 * receive path. This function is called by service functions that need
348 * to register or unregister a can_filter in the filter lists.
349 *
350 * A filter matches in general, when
351 *
352 * <received_can_id> & mask == can_id & mask
353 *
354 * so every bit set in the mask (even CAN_EFF_FLAG, CAN_RTR_FLAG) describe
355 * relevant bits for the filter.
356 *
357 * The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
Oliver Hartkoppd6e640f2012-05-08 22:20:33 +0200358 * filter for error messages (CAN_ERR_FLAG bit set in mask). For error msg
359 * frames there is a special filterlist and a special rx path filter handling.
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800360 *
361 * Return:
362 * Pointer to optimal filterlist for the given can_id/mask pair.
363 * Constistency checked mask.
364 * Reduced can_id to have a preprocessed filter compare value.
365 */
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800366static struct hlist_head *find_rcv_list(canid_t *can_id, canid_t *mask,
367 struct dev_rcv_lists *d)
368{
369 canid_t inv = *can_id & CAN_INV_FILTER; /* save flag before masking */
370
Oliver Hartkoppd6e640f2012-05-08 22:20:33 +0200371 /* filter for error message frames in extra filterlist */
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800372 if (*mask & CAN_ERR_FLAG) {
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800373 /* clear CAN_ERR_FLAG in filter entry */
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800374 *mask &= CAN_ERR_MASK;
375 return &d->rx[RX_ERR];
376 }
377
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800378 /* with cleared CAN_ERR_FLAG we have a simple mask/value filterpair */
379
380#define CAN_EFF_RTR_FLAGS (CAN_EFF_FLAG | CAN_RTR_FLAG)
381
382 /* ensure valid values in can_mask for 'SFF only' frame filtering */
383 if ((*mask & CAN_EFF_FLAG) && !(*can_id & CAN_EFF_FLAG))
384 *mask &= (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800385
386 /* reduce condition testing at receive time */
387 *can_id &= *mask;
388
389 /* inverse can_id/can_mask filter */
390 if (inv)
391 return &d->rx[RX_INV];
392
393 /* mask == 0 => no condition testing at receive time */
394 if (!(*mask))
395 return &d->rx[RX_ALL];
396
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800397 /* extra filterlists for the subscription of a single non-RTR can_id */
Joe Perchesf64f9e72009-11-29 16:55:45 -0800398 if (((*mask & CAN_EFF_RTR_FLAGS) == CAN_EFF_RTR_FLAGS) &&
399 !(*can_id & CAN_RTR_FLAG)) {
Oliver Hartkoppd253eee2008-12-03 15:52:35 -0800400
401 if (*can_id & CAN_EFF_FLAG) {
402 if (*mask == (CAN_EFF_MASK | CAN_EFF_RTR_FLAGS)) {
403 /* RFC: a future use-case for hash-tables? */
404 return &d->rx[RX_EFF];
405 }
406 } else {
407 if (*mask == (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS))
408 return &d->rx_sff[*can_id];
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800409 }
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800410 }
411
412 /* default: filter via can_id/can_mask */
413 return &d->rx[RX_FIL];
414}
415
416/**
417 * can_rx_register - subscribe CAN frames from a specific interface
418 * @dev: pointer to netdevice (NULL => subcribe from 'all' CAN devices list)
419 * @can_id: CAN identifier (see description)
420 * @mask: CAN mask (see description)
421 * @func: callback function on filter match
422 * @data: returned parameter for callback function
Maxime Jayat3f794102013-10-12 01:29:46 +0200423 * @ident: string for calling module identification
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800424 *
425 * Description:
426 * Invokes the callback function with the received sk_buff and the given
427 * parameter 'data' on a matching receive filter. A filter matches, when
428 *
429 * <received_can_id> & mask == can_id & mask
430 *
431 * The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
Oliver Hartkoppd6e640f2012-05-08 22:20:33 +0200432 * filter for error message frames (CAN_ERR_FLAG bit set in mask).
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800433 *
Oliver Hartkopp1fa17d42009-01-06 11:07:54 -0800434 * The provided pointer to the sk_buff is guaranteed to be valid as long as
435 * the callback function is running. The callback function must *not* free
436 * the given sk_buff while processing it's task. When the given sk_buff is
437 * needed after the end of the callback function it must be cloned inside
438 * the callback function with skb_clone().
439 *
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800440 * Return:
441 * 0 on success
442 * -ENOMEM on missing cache mem to create subscription entry
443 * -ENODEV unknown device
444 */
445int can_rx_register(struct net_device *dev, canid_t can_id, canid_t mask,
446 void (*func)(struct sk_buff *, void *), void *data,
447 char *ident)
448{
449 struct receiver *r;
450 struct hlist_head *rl;
451 struct dev_rcv_lists *d;
452 int err = 0;
453
454 /* insert new receiver (dev,canid,mask) -> (func,data) */
455
Oliver Hartkopp8b640562010-02-02 07:21:34 -0800456 if (dev && dev->type != ARPHRD_CAN)
457 return -ENODEV;
458
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800459 r = kmem_cache_alloc(rcv_cache, GFP_KERNEL);
460 if (!r)
461 return -ENOMEM;
462
463 spin_lock(&can_rcvlists_lock);
464
465 d = find_dev_rcv_lists(dev);
466 if (d) {
467 rl = find_rcv_list(&can_id, &mask, d);
468
469 r->can_id = can_id;
470 r->mask = mask;
471 r->matches = 0;
472 r->func = func;
473 r->data = data;
474 r->ident = ident;
475
476 hlist_add_head_rcu(&r->list, rl);
477 d->entries++;
478
479 can_pstats.rcv_entries++;
480 if (can_pstats.rcv_entries_max < can_pstats.rcv_entries)
481 can_pstats.rcv_entries_max = can_pstats.rcv_entries;
482 } else {
483 kmem_cache_free(rcv_cache, r);
484 err = -ENODEV;
485 }
486
487 spin_unlock(&can_rcvlists_lock);
488
489 return err;
490}
491EXPORT_SYMBOL(can_rx_register);
492
493/*
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800494 * can_rx_delete_receiver - rcu callback for single receiver entry removal
495 */
496static void can_rx_delete_receiver(struct rcu_head *rp)
497{
498 struct receiver *r = container_of(rp, struct receiver, rcu);
499
500 kmem_cache_free(rcv_cache, r);
501}
502
503/**
504 * can_rx_unregister - unsubscribe CAN frames from a specific interface
505 * @dev: pointer to netdevice (NULL => unsubcribe from 'all' CAN devices list)
506 * @can_id: CAN identifier
507 * @mask: CAN mask
508 * @func: callback function on filter match
509 * @data: returned parameter for callback function
510 *
511 * Description:
512 * Removes subscription entry depending on given (subscription) values.
513 */
514void can_rx_unregister(struct net_device *dev, canid_t can_id, canid_t mask,
515 void (*func)(struct sk_buff *, void *), void *data)
516{
517 struct receiver *r = NULL;
518 struct hlist_head *rl;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800519 struct dev_rcv_lists *d;
520
Oliver Hartkopp8b640562010-02-02 07:21:34 -0800521 if (dev && dev->type != ARPHRD_CAN)
522 return;
523
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800524 spin_lock(&can_rcvlists_lock);
525
526 d = find_dev_rcv_lists(dev);
527 if (!d) {
Valentin Ilief4f3efd2013-03-10 11:15:13 +0000528 pr_err("BUG: receive list not found for "
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800529 "dev %s, id %03X, mask %03X\n",
530 DNAME(dev), can_id, mask);
531 goto out;
532 }
533
534 rl = find_rcv_list(&can_id, &mask, d);
535
536 /*
537 * Search the receiver list for the item to delete. This should
538 * exist, since no receiver may be unregistered that hasn't
539 * been registered before.
540 */
541
Sasha Levinb67bfe02013-02-27 17:06:00 -0800542 hlist_for_each_entry_rcu(r, rl, list) {
Joe Perchesf64f9e72009-11-29 16:55:45 -0800543 if (r->can_id == can_id && r->mask == mask &&
544 r->func == func && r->data == data)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800545 break;
546 }
547
548 /*
Oliver Hartkoppc9bbb752013-03-18 07:52:06 +0000549 * Check for bugs in CAN protocol implementations using af_can.c:
550 * 'r' will be NULL if no matching list item was found for removal.
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800551 */
552
Sasha Levinb67bfe02013-02-27 17:06:00 -0800553 if (!r) {
Oliver Hartkoppc9bbb752013-03-18 07:52:06 +0000554 WARN(1, "BUG: receive list entry not found for dev %s, "
555 "id %03X, mask %03X\n", DNAME(dev), can_id, mask);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800556 goto out;
557 }
558
559 hlist_del_rcu(&r->list);
560 d->entries--;
561
562 if (can_pstats.rcv_entries > 0)
563 can_pstats.rcv_entries--;
564
565 /* remove device structure requested by NETDEV_UNREGISTER */
Oliver Hartkopp20dd3852009-12-25 06:47:47 +0000566 if (d->remove_on_zero_entries && !d->entries) {
567 kfree(d);
568 dev->ml_priv = NULL;
569 }
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800570
571 out:
572 spin_unlock(&can_rcvlists_lock);
573
574 /* schedule the receiver item for deletion */
575 if (r)
576 call_rcu(&r->rcu, can_rx_delete_receiver);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800577}
578EXPORT_SYMBOL(can_rx_unregister);
579
580static inline void deliver(struct sk_buff *skb, struct receiver *r)
581{
Oliver Hartkopp1fa17d42009-01-06 11:07:54 -0800582 r->func(skb, r->data);
583 r->matches++;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800584}
585
586static int can_rcv_filter(struct dev_rcv_lists *d, struct sk_buff *skb)
587{
588 struct receiver *r;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800589 int matches = 0;
590 struct can_frame *cf = (struct can_frame *)skb->data;
591 canid_t can_id = cf->can_id;
592
593 if (d->entries == 0)
594 return 0;
595
596 if (can_id & CAN_ERR_FLAG) {
Oliver Hartkoppd6e640f2012-05-08 22:20:33 +0200597 /* check for error message frame entries only */
Sasha Levinb67bfe02013-02-27 17:06:00 -0800598 hlist_for_each_entry_rcu(r, &d->rx[RX_ERR], list) {
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800599 if (can_id & r->mask) {
600 deliver(skb, r);
601 matches++;
602 }
603 }
604 return matches;
605 }
606
607 /* check for unfiltered entries */
Sasha Levinb67bfe02013-02-27 17:06:00 -0800608 hlist_for_each_entry_rcu(r, &d->rx[RX_ALL], list) {
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800609 deliver(skb, r);
610 matches++;
611 }
612
613 /* check for can_id/mask entries */
Sasha Levinb67bfe02013-02-27 17:06:00 -0800614 hlist_for_each_entry_rcu(r, &d->rx[RX_FIL], list) {
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800615 if ((can_id & r->mask) == r->can_id) {
616 deliver(skb, r);
617 matches++;
618 }
619 }
620
621 /* check for inverted can_id/mask entries */
Sasha Levinb67bfe02013-02-27 17:06:00 -0800622 hlist_for_each_entry_rcu(r, &d->rx[RX_INV], list) {
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800623 if ((can_id & r->mask) != r->can_id) {
624 deliver(skb, r);
625 matches++;
626 }
627 }
628
Oliver Hartkoppf706644d2008-12-04 15:01:08 -0800629 /* check filterlists for single non-RTR can_ids */
630 if (can_id & CAN_RTR_FLAG)
631 return matches;
632
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800633 if (can_id & CAN_EFF_FLAG) {
Sasha Levinb67bfe02013-02-27 17:06:00 -0800634 hlist_for_each_entry_rcu(r, &d->rx[RX_EFF], list) {
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800635 if (r->can_id == can_id) {
636 deliver(skb, r);
637 matches++;
638 }
639 }
640 } else {
641 can_id &= CAN_SFF_MASK;
Sasha Levinb67bfe02013-02-27 17:06:00 -0800642 hlist_for_each_entry_rcu(r, &d->rx_sff[can_id], list) {
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800643 deliver(skb, r);
644 matches++;
645 }
646 }
647
648 return matches;
649}
650
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200651static void can_receive(struct sk_buff *skb, struct net_device *dev)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800652{
653 struct dev_rcv_lists *d;
654 int matches;
655
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800656 /* update statistics */
657 can_stats.rx_frames++;
658 can_stats.rx_frames_delta++;
659
660 rcu_read_lock();
661
662 /* deliver the packet to sockets listening on all devices */
663 matches = can_rcv_filter(&can_rx_alldev_list, skb);
664
665 /* find receive list for this device */
666 d = find_dev_rcv_lists(dev);
667 if (d)
668 matches += can_rcv_filter(d, skb);
669
670 rcu_read_unlock();
671
Oliver Hartkopp62bcaa12009-04-17 01:38:46 -0700672 /* consume the skbuff allocated by the netdevice driver */
673 consume_skb(skb);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800674
675 if (matches > 0) {
676 can_stats.matches++;
677 can_stats.matches_delta++;
678 }
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200679}
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800680
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200681static int can_rcv(struct sk_buff *skb, struct net_device *dev,
682 struct packet_type *pt, struct net_device *orig_dev)
683{
684 struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
685
686 if (unlikely(!net_eq(dev_net(dev), &init_net)))
687 goto drop;
688
689 if (WARN_ONCE(dev->type != ARPHRD_CAN ||
690 skb->len != CAN_MTU ||
691 cfd->len > CAN_MAX_DLEN,
692 "PF_CAN: dropped non conform CAN skbuf: "
693 "dev type %d, len %d, datalen %d\n",
694 dev->type, skb->len, cfd->len))
695 goto drop;
696
697 can_receive(skb, dev);
698 return NET_RX_SUCCESS;
699
700drop:
701 kfree_skb(skb);
702 return NET_RX_DROP;
703}
704
705static int canfd_rcv(struct sk_buff *skb, struct net_device *dev,
706 struct packet_type *pt, struct net_device *orig_dev)
707{
708 struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
709
710 if (unlikely(!net_eq(dev_net(dev), &init_net)))
711 goto drop;
712
713 if (WARN_ONCE(dev->type != ARPHRD_CAN ||
714 skb->len != CANFD_MTU ||
715 cfd->len > CANFD_MAX_DLEN,
716 "PF_CAN: dropped non conform CAN FD skbuf: "
717 "dev type %d, len %d, datalen %d\n",
718 dev->type, skb->len, cfd->len))
719 goto drop;
720
721 can_receive(skb, dev);
Oliver Hartkopp6ca8b992009-08-29 06:45:09 +0000722 return NET_RX_SUCCESS;
Oliver Hartkopp1758c092009-08-13 22:54:25 +0000723
724drop:
725 kfree_skb(skb);
Oliver Hartkopp6ca8b992009-08-29 06:45:09 +0000726 return NET_RX_DROP;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800727}
728
729/*
730 * af_can protocol functions
731 */
732
733/**
734 * can_proto_register - register CAN transport protocol
735 * @cp: pointer to CAN protocol structure
736 *
737 * Return:
738 * 0 on success
739 * -EINVAL invalid (out of range) protocol number
740 * -EBUSY protocol already in use
741 * -ENOBUF if proto_register() fails
742 */
Kurt Van Dijck16506292011-05-03 18:40:57 +0000743int can_proto_register(const struct can_proto *cp)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800744{
745 int proto = cp->protocol;
746 int err = 0;
747
748 if (proto < 0 || proto >= CAN_NPROTO) {
Valentin Ilief4f3efd2013-03-10 11:15:13 +0000749 pr_err("can: protocol number %d out of range\n", proto);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800750 return -EINVAL;
751 }
752
Urs Thuermanna2fea5f2008-02-07 18:04:45 -0800753 err = proto_register(cp->prot, 0);
754 if (err < 0)
755 return err;
756
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000757 mutex_lock(&proto_tab_lock);
758
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800759 if (proto_tab[proto]) {
Valentin Ilief4f3efd2013-03-10 11:15:13 +0000760 pr_err("can: protocol %d already registered\n", proto);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800761 err = -EBUSY;
Oliver Hartkopp53914b62011-03-22 08:27:25 +0000762 } else
Stephen Hemmingera9b3cd72011-08-01 16:19:00 +0000763 RCU_INIT_POINTER(proto_tab[proto], cp);
Urs Thuermanna2fea5f2008-02-07 18:04:45 -0800764
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000765 mutex_unlock(&proto_tab_lock);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800766
Urs Thuermanna2fea5f2008-02-07 18:04:45 -0800767 if (err < 0)
768 proto_unregister(cp->prot);
769
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800770 return err;
771}
772EXPORT_SYMBOL(can_proto_register);
773
774/**
775 * can_proto_unregister - unregister CAN transport protocol
776 * @cp: pointer to CAN protocol structure
777 */
Kurt Van Dijck16506292011-05-03 18:40:57 +0000778void can_proto_unregister(const struct can_proto *cp)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800779{
780 int proto = cp->protocol;
781
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000782 mutex_lock(&proto_tab_lock);
783 BUG_ON(proto_tab[proto] != cp);
Stephen Hemmingera9b3cd72011-08-01 16:19:00 +0000784 RCU_INIT_POINTER(proto_tab[proto], NULL);
Oliver Hartkopp1ca050d2011-04-05 08:01:16 +0000785 mutex_unlock(&proto_tab_lock);
786
787 synchronize_rcu();
Urs Thuermanna2fea5f2008-02-07 18:04:45 -0800788
789 proto_unregister(cp->prot);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800790}
791EXPORT_SYMBOL(can_proto_unregister);
792
793/*
794 * af_can notifier to create/remove CAN netdevice specific structs
795 */
796static int can_notifier(struct notifier_block *nb, unsigned long msg,
Jiri Pirko351638e2013-05-28 01:30:21 +0000797 void *ptr)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800798{
Jiri Pirko351638e2013-05-28 01:30:21 +0000799 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800800 struct dev_rcv_lists *d;
801
YOSHIFUJI Hideaki721499e2008-07-19 22:34:43 -0700802 if (!net_eq(dev_net(dev), &init_net))
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800803 return NOTIFY_DONE;
804
805 if (dev->type != ARPHRD_CAN)
806 return NOTIFY_DONE;
807
808 switch (msg) {
809
810 case NETDEV_REGISTER:
811
Oliver Hartkopp20dd3852009-12-25 06:47:47 +0000812 /* create new dev_rcv_lists for this device */
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800813 d = kzalloc(sizeof(*d), GFP_KERNEL);
Valentin Ilief4f3efd2013-03-10 11:15:13 +0000814 if (!d)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800815 return NOTIFY_DONE;
Oliver Hartkopp20dd3852009-12-25 06:47:47 +0000816 BUG_ON(dev->ml_priv);
817 dev->ml_priv = d;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800818
819 break;
820
821 case NETDEV_UNREGISTER:
822 spin_lock(&can_rcvlists_lock);
823
Oliver Hartkopp20dd3852009-12-25 06:47:47 +0000824 d = dev->ml_priv;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800825 if (d) {
Oliver Hartkopp20dd3852009-12-25 06:47:47 +0000826 if (d->entries)
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800827 d->remove_on_zero_entries = 1;
Oliver Hartkopp20dd3852009-12-25 06:47:47 +0000828 else {
829 kfree(d);
830 dev->ml_priv = NULL;
831 }
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800832 } else
Valentin Ilief4f3efd2013-03-10 11:15:13 +0000833 pr_err("can: notifier: receive list not found for dev "
834 "%s\n", dev->name);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800835
836 spin_unlock(&can_rcvlists_lock);
837
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800838 break;
839 }
840
841 return NOTIFY_DONE;
842}
843
844/*
845 * af_can module init/exit functions
846 */
847
848static struct packet_type can_packet __read_mostly = {
Harvey Harrison09640e62009-02-01 00:45:17 -0800849 .type = cpu_to_be16(ETH_P_CAN),
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800850 .func = can_rcv,
851};
852
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200853static struct packet_type canfd_packet __read_mostly = {
854 .type = cpu_to_be16(ETH_P_CANFD),
855 .func = canfd_rcv,
856};
857
Stephen Hemmingerec1b4cf2009-10-05 05:58:39 +0000858static const struct net_proto_family can_family_ops = {
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800859 .family = PF_CAN,
860 .create = can_create,
861 .owner = THIS_MODULE,
862};
863
864/* notifier block for netdevice event */
865static struct notifier_block can_netdev_notifier __read_mostly = {
866 .notifier_call = can_notifier,
867};
868
869static __init int can_init(void)
870{
Oliver Hartkopp7c941632012-06-13 20:04:33 +0200871 /* check for correct padding to be able to use the structs similarly */
872 BUILD_BUG_ON(offsetof(struct can_frame, can_dlc) !=
873 offsetof(struct canfd_frame, len) ||
874 offsetof(struct can_frame, data) !=
875 offsetof(struct canfd_frame, data));
876
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800877 printk(banner);
878
Oliver Hartkopp20dd3852009-12-25 06:47:47 +0000879 memset(&can_rx_alldev_list, 0, sizeof(can_rx_alldev_list));
880
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800881 rcv_cache = kmem_cache_create("can_receiver", sizeof(struct receiver),
882 0, 0, NULL);
883 if (!rcv_cache)
884 return -ENOMEM;
885
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800886 if (stats_timer) {
887 /* the statistics are updated every second (timer triggered) */
888 setup_timer(&can_stattimer, can_stat_update, 0);
889 mod_timer(&can_stattimer, round_jiffies(jiffies + HZ));
890 } else
891 can_stattimer.function = NULL;
892
893 can_init_proc();
894
895 /* protocol register */
896 sock_register(&can_family_ops);
897 register_netdevice_notifier(&can_netdev_notifier);
898 dev_add_pack(&can_packet);
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200899 dev_add_pack(&canfd_packet);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800900
901 return 0;
902}
903
904static __exit void can_exit(void)
905{
Oliver Hartkopp20dd3852009-12-25 06:47:47 +0000906 struct net_device *dev;
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800907
908 if (stats_timer)
rajan.aggarwal85@gmail.comd9e64f82011-08-30 23:57:38 +0000909 del_timer_sync(&can_stattimer);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800910
911 can_remove_proc();
912
913 /* protocol unregister */
Oliver Hartkopp8b019392012-06-13 20:33:02 +0200914 dev_remove_pack(&canfd_packet);
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800915 dev_remove_pack(&can_packet);
916 unregister_netdevice_notifier(&can_netdev_notifier);
917 sock_unregister(PF_CAN);
918
Oliver Hartkopp20dd3852009-12-25 06:47:47 +0000919 /* remove created dev_rcv_lists from still registered CAN devices */
920 rcu_read_lock();
921 for_each_netdev_rcu(&init_net, dev) {
Valentin Ilief4f3efd2013-03-10 11:15:13 +0000922 if (dev->type == ARPHRD_CAN && dev->ml_priv) {
Oliver Hartkopp20dd3852009-12-25 06:47:47 +0000923
924 struct dev_rcv_lists *d = dev->ml_priv;
925
926 BUG_ON(d->entries);
927 kfree(d);
928 dev->ml_priv = NULL;
929 }
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800930 }
Oliver Hartkopp20dd3852009-12-25 06:47:47 +0000931 rcu_read_unlock();
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800932
Jesper Dangaard Brouer382bfee2009-06-08 03:11:38 +0000933 rcu_barrier(); /* Wait for completion of call_rcu()'s */
934
Oliver Hartkopp0d665482007-11-16 15:52:17 -0800935 kmem_cache_destroy(rcv_cache);
936}
937
938module_init(can_init);
939module_exit(can_exit);