18c2ecf20Sopenharmony_ci// SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
28c2ecf20Sopenharmony_ci/* af_can.c - Protocol family CAN core module
38c2ecf20Sopenharmony_ci *            (used by different CAN protocol modules)
48c2ecf20Sopenharmony_ci *
58c2ecf20Sopenharmony_ci * Copyright (c) 2002-2017 Volkswagen Group Electronic Research
68c2ecf20Sopenharmony_ci * All rights reserved.
78c2ecf20Sopenharmony_ci *
88c2ecf20Sopenharmony_ci * Redistribution and use in source and binary forms, with or without
98c2ecf20Sopenharmony_ci * modification, are permitted provided that the following conditions
108c2ecf20Sopenharmony_ci * are met:
118c2ecf20Sopenharmony_ci * 1. Redistributions of source code must retain the above copyright
128c2ecf20Sopenharmony_ci *    notice, this list of conditions and the following disclaimer.
138c2ecf20Sopenharmony_ci * 2. Redistributions in binary form must reproduce the above copyright
148c2ecf20Sopenharmony_ci *    notice, this list of conditions and the following disclaimer in the
158c2ecf20Sopenharmony_ci *    documentation and/or other materials provided with the distribution.
168c2ecf20Sopenharmony_ci * 3. Neither the name of Volkswagen nor the names of its contributors
178c2ecf20Sopenharmony_ci *    may be used to endorse or promote products derived from this software
188c2ecf20Sopenharmony_ci *    without specific prior written permission.
198c2ecf20Sopenharmony_ci *
208c2ecf20Sopenharmony_ci * Alternatively, provided that this notice is retained in full, this
218c2ecf20Sopenharmony_ci * software may be distributed under the terms of the GNU General
228c2ecf20Sopenharmony_ci * Public License ("GPL") version 2, in which case the provisions of the
238c2ecf20Sopenharmony_ci * GPL apply INSTEAD OF those given above.
248c2ecf20Sopenharmony_ci *
258c2ecf20Sopenharmony_ci * The provided data structures and external interfaces from this code
268c2ecf20Sopenharmony_ci * are not restricted to be used by modules with a GPL compatible license.
278c2ecf20Sopenharmony_ci *
288c2ecf20Sopenharmony_ci * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
298c2ecf20Sopenharmony_ci * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
308c2ecf20Sopenharmony_ci * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
318c2ecf20Sopenharmony_ci * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
328c2ecf20Sopenharmony_ci * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
338c2ecf20Sopenharmony_ci * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
348c2ecf20Sopenharmony_ci * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
358c2ecf20Sopenharmony_ci * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
368c2ecf20Sopenharmony_ci * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
378c2ecf20Sopenharmony_ci * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
388c2ecf20Sopenharmony_ci * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
398c2ecf20Sopenharmony_ci * DAMAGE.
408c2ecf20Sopenharmony_ci *
418c2ecf20Sopenharmony_ci */
428c2ecf20Sopenharmony_ci
438c2ecf20Sopenharmony_ci#include <linux/module.h>
448c2ecf20Sopenharmony_ci#include <linux/stddef.h>
458c2ecf20Sopenharmony_ci#include <linux/init.h>
468c2ecf20Sopenharmony_ci#include <linux/kmod.h>
478c2ecf20Sopenharmony_ci#include <linux/slab.h>
488c2ecf20Sopenharmony_ci#include <linux/list.h>
498c2ecf20Sopenharmony_ci#include <linux/spinlock.h>
508c2ecf20Sopenharmony_ci#include <linux/rcupdate.h>
518c2ecf20Sopenharmony_ci#include <linux/uaccess.h>
528c2ecf20Sopenharmony_ci#include <linux/net.h>
538c2ecf20Sopenharmony_ci#include <linux/netdevice.h>
548c2ecf20Sopenharmony_ci#include <linux/socket.h>
558c2ecf20Sopenharmony_ci#include <linux/if_ether.h>
568c2ecf20Sopenharmony_ci#include <linux/if_arp.h>
578c2ecf20Sopenharmony_ci#include <linux/skbuff.h>
588c2ecf20Sopenharmony_ci#include <linux/can.h>
598c2ecf20Sopenharmony_ci#include <linux/can/core.h>
608c2ecf20Sopenharmony_ci#include <linux/can/skb.h>
618c2ecf20Sopenharmony_ci#include <linux/can/can-ml.h>
628c2ecf20Sopenharmony_ci#include <linux/ratelimit.h>
638c2ecf20Sopenharmony_ci#include <net/net_namespace.h>
648c2ecf20Sopenharmony_ci#include <net/sock.h>
658c2ecf20Sopenharmony_ci
668c2ecf20Sopenharmony_ci#include "af_can.h"
678c2ecf20Sopenharmony_ci
688c2ecf20Sopenharmony_ciMODULE_DESCRIPTION("Controller Area Network PF_CAN core");
698c2ecf20Sopenharmony_ciMODULE_LICENSE("Dual BSD/GPL");
708c2ecf20Sopenharmony_ciMODULE_AUTHOR("Urs Thuermann <urs.thuermann@volkswagen.de>, "
718c2ecf20Sopenharmony_ci	      "Oliver Hartkopp <oliver.hartkopp@volkswagen.de>");
728c2ecf20Sopenharmony_ci
738c2ecf20Sopenharmony_ciMODULE_ALIAS_NETPROTO(PF_CAN);
748c2ecf20Sopenharmony_ci
758c2ecf20Sopenharmony_cistatic int stats_timer __read_mostly = 1;
768c2ecf20Sopenharmony_cimodule_param(stats_timer, int, 0444);
778c2ecf20Sopenharmony_ciMODULE_PARM_DESC(stats_timer, "enable timer for statistics (default:on)");
788c2ecf20Sopenharmony_ci
798c2ecf20Sopenharmony_cistatic struct kmem_cache *rcv_cache __read_mostly;
808c2ecf20Sopenharmony_ci
818c2ecf20Sopenharmony_ci/* table of registered CAN protocols */
828c2ecf20Sopenharmony_cistatic const struct can_proto __rcu *proto_tab[CAN_NPROTO] __read_mostly;
838c2ecf20Sopenharmony_cistatic DEFINE_MUTEX(proto_tab_lock);
848c2ecf20Sopenharmony_ci
858c2ecf20Sopenharmony_cistatic atomic_t skbcounter = ATOMIC_INIT(0);
868c2ecf20Sopenharmony_ci
878c2ecf20Sopenharmony_ci/* af_can socket functions */
888c2ecf20Sopenharmony_ci
898c2ecf20Sopenharmony_civoid can_sock_destruct(struct sock *sk)
908c2ecf20Sopenharmony_ci{
918c2ecf20Sopenharmony_ci	skb_queue_purge(&sk->sk_receive_queue);
928c2ecf20Sopenharmony_ci	skb_queue_purge(&sk->sk_error_queue);
938c2ecf20Sopenharmony_ci}
948c2ecf20Sopenharmony_ciEXPORT_SYMBOL(can_sock_destruct);
958c2ecf20Sopenharmony_ci
968c2ecf20Sopenharmony_cistatic const struct can_proto *can_get_proto(int protocol)
978c2ecf20Sopenharmony_ci{
988c2ecf20Sopenharmony_ci	const struct can_proto *cp;
998c2ecf20Sopenharmony_ci
1008c2ecf20Sopenharmony_ci	rcu_read_lock();
1018c2ecf20Sopenharmony_ci	cp = rcu_dereference(proto_tab[protocol]);
1028c2ecf20Sopenharmony_ci	if (cp && !try_module_get(cp->prot->owner))
1038c2ecf20Sopenharmony_ci		cp = NULL;
1048c2ecf20Sopenharmony_ci	rcu_read_unlock();
1058c2ecf20Sopenharmony_ci
1068c2ecf20Sopenharmony_ci	return cp;
1078c2ecf20Sopenharmony_ci}
1088c2ecf20Sopenharmony_ci
1098c2ecf20Sopenharmony_cistatic inline void can_put_proto(const struct can_proto *cp)
1108c2ecf20Sopenharmony_ci{
1118c2ecf20Sopenharmony_ci	module_put(cp->prot->owner);
1128c2ecf20Sopenharmony_ci}
1138c2ecf20Sopenharmony_ci
1148c2ecf20Sopenharmony_cistatic int can_create(struct net *net, struct socket *sock, int protocol,
1158c2ecf20Sopenharmony_ci		      int kern)
1168c2ecf20Sopenharmony_ci{
1178c2ecf20Sopenharmony_ci	struct sock *sk;
1188c2ecf20Sopenharmony_ci	const struct can_proto *cp;
1198c2ecf20Sopenharmony_ci	int err = 0;
1208c2ecf20Sopenharmony_ci
1218c2ecf20Sopenharmony_ci	sock->state = SS_UNCONNECTED;
1228c2ecf20Sopenharmony_ci
1238c2ecf20Sopenharmony_ci	if (protocol < 0 || protocol >= CAN_NPROTO)
1248c2ecf20Sopenharmony_ci		return -EINVAL;
1258c2ecf20Sopenharmony_ci
1268c2ecf20Sopenharmony_ci	cp = can_get_proto(protocol);
1278c2ecf20Sopenharmony_ci
1288c2ecf20Sopenharmony_ci#ifdef CONFIG_MODULES
1298c2ecf20Sopenharmony_ci	if (!cp) {
1308c2ecf20Sopenharmony_ci		/* try to load protocol module if kernel is modular */
1318c2ecf20Sopenharmony_ci
1328c2ecf20Sopenharmony_ci		err = request_module("can-proto-%d", protocol);
1338c2ecf20Sopenharmony_ci
1348c2ecf20Sopenharmony_ci		/* In case of error we only print a message but don't
1358c2ecf20Sopenharmony_ci		 * return the error code immediately.  Below we will
1368c2ecf20Sopenharmony_ci		 * return -EPROTONOSUPPORT
1378c2ecf20Sopenharmony_ci		 */
1388c2ecf20Sopenharmony_ci		if (err)
1398c2ecf20Sopenharmony_ci			pr_err_ratelimited("can: request_module (can-proto-%d) failed.\n",
1408c2ecf20Sopenharmony_ci					   protocol);
1418c2ecf20Sopenharmony_ci
1428c2ecf20Sopenharmony_ci		cp = can_get_proto(protocol);
1438c2ecf20Sopenharmony_ci	}
1448c2ecf20Sopenharmony_ci#endif
1458c2ecf20Sopenharmony_ci
1468c2ecf20Sopenharmony_ci	/* check for available protocol and correct usage */
1478c2ecf20Sopenharmony_ci
1488c2ecf20Sopenharmony_ci	if (!cp)
1498c2ecf20Sopenharmony_ci		return -EPROTONOSUPPORT;
1508c2ecf20Sopenharmony_ci
1518c2ecf20Sopenharmony_ci	if (cp->type != sock->type) {
1528c2ecf20Sopenharmony_ci		err = -EPROTOTYPE;
1538c2ecf20Sopenharmony_ci		goto errout;
1548c2ecf20Sopenharmony_ci	}
1558c2ecf20Sopenharmony_ci
1568c2ecf20Sopenharmony_ci	sock->ops = cp->ops;
1578c2ecf20Sopenharmony_ci
1588c2ecf20Sopenharmony_ci	sk = sk_alloc(net, PF_CAN, GFP_KERNEL, cp->prot, kern);
1598c2ecf20Sopenharmony_ci	if (!sk) {
1608c2ecf20Sopenharmony_ci		err = -ENOMEM;
1618c2ecf20Sopenharmony_ci		goto errout;
1628c2ecf20Sopenharmony_ci	}
1638c2ecf20Sopenharmony_ci
1648c2ecf20Sopenharmony_ci	sock_init_data(sock, sk);
1658c2ecf20Sopenharmony_ci	sk->sk_destruct = can_sock_destruct;
1668c2ecf20Sopenharmony_ci
1678c2ecf20Sopenharmony_ci	if (sk->sk_prot->init)
1688c2ecf20Sopenharmony_ci		err = sk->sk_prot->init(sk);
1698c2ecf20Sopenharmony_ci
1708c2ecf20Sopenharmony_ci	if (err) {
1718c2ecf20Sopenharmony_ci		/* release sk on errors */
1728c2ecf20Sopenharmony_ci		sock_orphan(sk);
1738c2ecf20Sopenharmony_ci		sock_put(sk);
1748c2ecf20Sopenharmony_ci	}
1758c2ecf20Sopenharmony_ci
1768c2ecf20Sopenharmony_ci errout:
1778c2ecf20Sopenharmony_ci	can_put_proto(cp);
1788c2ecf20Sopenharmony_ci	return err;
1798c2ecf20Sopenharmony_ci}
1808c2ecf20Sopenharmony_ci
1818c2ecf20Sopenharmony_ci/* af_can tx path */
1828c2ecf20Sopenharmony_ci
1838c2ecf20Sopenharmony_ci/**
1848c2ecf20Sopenharmony_ci * can_send - transmit a CAN frame (optional with local loopback)
1858c2ecf20Sopenharmony_ci * @skb: pointer to socket buffer with CAN frame in data section
1868c2ecf20Sopenharmony_ci * @loop: loopback for listeners on local CAN sockets (recommended default!)
1878c2ecf20Sopenharmony_ci *
1888c2ecf20Sopenharmony_ci * Due to the loopback this routine must not be called from hardirq context.
1898c2ecf20Sopenharmony_ci *
1908c2ecf20Sopenharmony_ci * Return:
1918c2ecf20Sopenharmony_ci *  0 on success
1928c2ecf20Sopenharmony_ci *  -ENETDOWN when the selected interface is down
1938c2ecf20Sopenharmony_ci *  -ENOBUFS on full driver queue (see net_xmit_errno())
1948c2ecf20Sopenharmony_ci *  -ENOMEM when local loopback failed at calling skb_clone()
1958c2ecf20Sopenharmony_ci *  -EPERM when trying to send on a non-CAN interface
1968c2ecf20Sopenharmony_ci *  -EMSGSIZE CAN frame size is bigger than CAN interface MTU
1978c2ecf20Sopenharmony_ci *  -EINVAL when the skb->data does not contain a valid CAN frame
1988c2ecf20Sopenharmony_ci */
1998c2ecf20Sopenharmony_ciint can_send(struct sk_buff *skb, int loop)
2008c2ecf20Sopenharmony_ci{
2018c2ecf20Sopenharmony_ci	struct sk_buff *newskb = NULL;
2028c2ecf20Sopenharmony_ci	struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
2038c2ecf20Sopenharmony_ci	struct can_pkg_stats *pkg_stats = dev_net(skb->dev)->can.pkg_stats;
2048c2ecf20Sopenharmony_ci	int err = -EINVAL;
2058c2ecf20Sopenharmony_ci
2068c2ecf20Sopenharmony_ci	if (skb->len == CAN_MTU) {
2078c2ecf20Sopenharmony_ci		skb->protocol = htons(ETH_P_CAN);
2088c2ecf20Sopenharmony_ci		if (unlikely(cfd->len > CAN_MAX_DLEN))
2098c2ecf20Sopenharmony_ci			goto inval_skb;
2108c2ecf20Sopenharmony_ci	} else if (skb->len == CANFD_MTU) {
2118c2ecf20Sopenharmony_ci		skb->protocol = htons(ETH_P_CANFD);
2128c2ecf20Sopenharmony_ci		if (unlikely(cfd->len > CANFD_MAX_DLEN))
2138c2ecf20Sopenharmony_ci			goto inval_skb;
2148c2ecf20Sopenharmony_ci	} else {
2158c2ecf20Sopenharmony_ci		goto inval_skb;
2168c2ecf20Sopenharmony_ci	}
2178c2ecf20Sopenharmony_ci
2188c2ecf20Sopenharmony_ci	/* Make sure the CAN frame can pass the selected CAN netdevice.
2198c2ecf20Sopenharmony_ci	 * As structs can_frame and canfd_frame are similar, we can provide
2208c2ecf20Sopenharmony_ci	 * CAN FD frames to legacy CAN drivers as long as the length is <= 8
2218c2ecf20Sopenharmony_ci	 */
2228c2ecf20Sopenharmony_ci	if (unlikely(skb->len > skb->dev->mtu && cfd->len > CAN_MAX_DLEN)) {
2238c2ecf20Sopenharmony_ci		err = -EMSGSIZE;
2248c2ecf20Sopenharmony_ci		goto inval_skb;
2258c2ecf20Sopenharmony_ci	}
2268c2ecf20Sopenharmony_ci
2278c2ecf20Sopenharmony_ci	if (unlikely(skb->dev->type != ARPHRD_CAN)) {
2288c2ecf20Sopenharmony_ci		err = -EPERM;
2298c2ecf20Sopenharmony_ci		goto inval_skb;
2308c2ecf20Sopenharmony_ci	}
2318c2ecf20Sopenharmony_ci
2328c2ecf20Sopenharmony_ci	if (unlikely(!(skb->dev->flags & IFF_UP))) {
2338c2ecf20Sopenharmony_ci		err = -ENETDOWN;
2348c2ecf20Sopenharmony_ci		goto inval_skb;
2358c2ecf20Sopenharmony_ci	}
2368c2ecf20Sopenharmony_ci
2378c2ecf20Sopenharmony_ci	skb->ip_summed = CHECKSUM_UNNECESSARY;
2388c2ecf20Sopenharmony_ci
2398c2ecf20Sopenharmony_ci	skb_reset_mac_header(skb);
2408c2ecf20Sopenharmony_ci	skb_reset_network_header(skb);
2418c2ecf20Sopenharmony_ci	skb_reset_transport_header(skb);
2428c2ecf20Sopenharmony_ci
2438c2ecf20Sopenharmony_ci	if (loop) {
2448c2ecf20Sopenharmony_ci		/* local loopback of sent CAN frames */
2458c2ecf20Sopenharmony_ci
2468c2ecf20Sopenharmony_ci		/* indication for the CAN driver: do loopback */
2478c2ecf20Sopenharmony_ci		skb->pkt_type = PACKET_LOOPBACK;
2488c2ecf20Sopenharmony_ci
2498c2ecf20Sopenharmony_ci		/* The reference to the originating sock may be required
2508c2ecf20Sopenharmony_ci		 * by the receiving socket to check whether the frame is
2518c2ecf20Sopenharmony_ci		 * its own. Example: can_raw sockopt CAN_RAW_RECV_OWN_MSGS
2528c2ecf20Sopenharmony_ci		 * Therefore we have to ensure that skb->sk remains the
2538c2ecf20Sopenharmony_ci		 * reference to the originating sock by restoring skb->sk
2548c2ecf20Sopenharmony_ci		 * after each skb_clone() or skb_orphan() usage.
2558c2ecf20Sopenharmony_ci		 */
2568c2ecf20Sopenharmony_ci
2578c2ecf20Sopenharmony_ci		if (!(skb->dev->flags & IFF_ECHO)) {
2588c2ecf20Sopenharmony_ci			/* If the interface is not capable to do loopback
2598c2ecf20Sopenharmony_ci			 * itself, we do it here.
2608c2ecf20Sopenharmony_ci			 */
2618c2ecf20Sopenharmony_ci			newskb = skb_clone(skb, GFP_ATOMIC);
2628c2ecf20Sopenharmony_ci			if (!newskb) {
2638c2ecf20Sopenharmony_ci				kfree_skb(skb);
2648c2ecf20Sopenharmony_ci				return -ENOMEM;
2658c2ecf20Sopenharmony_ci			}
2668c2ecf20Sopenharmony_ci
2678c2ecf20Sopenharmony_ci			can_skb_set_owner(newskb, skb->sk);
2688c2ecf20Sopenharmony_ci			newskb->ip_summed = CHECKSUM_UNNECESSARY;
2698c2ecf20Sopenharmony_ci			newskb->pkt_type = PACKET_BROADCAST;
2708c2ecf20Sopenharmony_ci		}
2718c2ecf20Sopenharmony_ci	} else {
2728c2ecf20Sopenharmony_ci		/* indication for the CAN driver: no loopback required */
2738c2ecf20Sopenharmony_ci		skb->pkt_type = PACKET_HOST;
2748c2ecf20Sopenharmony_ci	}
2758c2ecf20Sopenharmony_ci
2768c2ecf20Sopenharmony_ci	/* send to netdevice */
2778c2ecf20Sopenharmony_ci	err = dev_queue_xmit(skb);
2788c2ecf20Sopenharmony_ci	if (err > 0)
2798c2ecf20Sopenharmony_ci		err = net_xmit_errno(err);
2808c2ecf20Sopenharmony_ci
2818c2ecf20Sopenharmony_ci	if (err) {
2828c2ecf20Sopenharmony_ci		kfree_skb(newskb);
2838c2ecf20Sopenharmony_ci		return err;
2848c2ecf20Sopenharmony_ci	}
2858c2ecf20Sopenharmony_ci
2868c2ecf20Sopenharmony_ci	if (newskb)
2878c2ecf20Sopenharmony_ci		netif_rx_ni(newskb);
2888c2ecf20Sopenharmony_ci
2898c2ecf20Sopenharmony_ci	/* update statistics */
2908c2ecf20Sopenharmony_ci	pkg_stats->tx_frames++;
2918c2ecf20Sopenharmony_ci	pkg_stats->tx_frames_delta++;
2928c2ecf20Sopenharmony_ci
2938c2ecf20Sopenharmony_ci	return 0;
2948c2ecf20Sopenharmony_ci
2958c2ecf20Sopenharmony_ciinval_skb:
2968c2ecf20Sopenharmony_ci	kfree_skb(skb);
2978c2ecf20Sopenharmony_ci	return err;
2988c2ecf20Sopenharmony_ci}
2998c2ecf20Sopenharmony_ciEXPORT_SYMBOL(can_send);
3008c2ecf20Sopenharmony_ci
3018c2ecf20Sopenharmony_ci/* af_can rx path */
3028c2ecf20Sopenharmony_ci
3038c2ecf20Sopenharmony_cistatic struct can_dev_rcv_lists *can_dev_rcv_lists_find(struct net *net,
3048c2ecf20Sopenharmony_ci							struct net_device *dev)
3058c2ecf20Sopenharmony_ci{
3068c2ecf20Sopenharmony_ci	if (dev) {
3078c2ecf20Sopenharmony_ci		struct can_ml_priv *can_ml = can_get_ml_priv(dev);
3088c2ecf20Sopenharmony_ci		return &can_ml->dev_rcv_lists;
3098c2ecf20Sopenharmony_ci	} else {
3108c2ecf20Sopenharmony_ci		return net->can.rx_alldev_list;
3118c2ecf20Sopenharmony_ci	}
3128c2ecf20Sopenharmony_ci}
3138c2ecf20Sopenharmony_ci
3148c2ecf20Sopenharmony_ci/**
3158c2ecf20Sopenharmony_ci * effhash - hash function for 29 bit CAN identifier reduction
3168c2ecf20Sopenharmony_ci * @can_id: 29 bit CAN identifier
3178c2ecf20Sopenharmony_ci *
3188c2ecf20Sopenharmony_ci * Description:
3198c2ecf20Sopenharmony_ci *  To reduce the linear traversal in one linked list of _single_ EFF CAN
3208c2ecf20Sopenharmony_ci *  frame subscriptions the 29 bit identifier is mapped to 10 bits.
3218c2ecf20Sopenharmony_ci *  (see CAN_EFF_RCV_HASH_BITS definition)
3228c2ecf20Sopenharmony_ci *
3238c2ecf20Sopenharmony_ci * Return:
3248c2ecf20Sopenharmony_ci *  Hash value from 0x000 - 0x3FF ( enforced by CAN_EFF_RCV_HASH_BITS mask )
3258c2ecf20Sopenharmony_ci */
3268c2ecf20Sopenharmony_cistatic unsigned int effhash(canid_t can_id)
3278c2ecf20Sopenharmony_ci{
3288c2ecf20Sopenharmony_ci	unsigned int hash;
3298c2ecf20Sopenharmony_ci
3308c2ecf20Sopenharmony_ci	hash = can_id;
3318c2ecf20Sopenharmony_ci	hash ^= can_id >> CAN_EFF_RCV_HASH_BITS;
3328c2ecf20Sopenharmony_ci	hash ^= can_id >> (2 * CAN_EFF_RCV_HASH_BITS);
3338c2ecf20Sopenharmony_ci
3348c2ecf20Sopenharmony_ci	return hash & ((1 << CAN_EFF_RCV_HASH_BITS) - 1);
3358c2ecf20Sopenharmony_ci}
3368c2ecf20Sopenharmony_ci
3378c2ecf20Sopenharmony_ci/**
3388c2ecf20Sopenharmony_ci * can_rcv_list_find - determine optimal filterlist inside device filter struct
3398c2ecf20Sopenharmony_ci * @can_id: pointer to CAN identifier of a given can_filter
3408c2ecf20Sopenharmony_ci * @mask: pointer to CAN mask of a given can_filter
3418c2ecf20Sopenharmony_ci * @dev_rcv_lists: pointer to the device filter struct
3428c2ecf20Sopenharmony_ci *
3438c2ecf20Sopenharmony_ci * Description:
3448c2ecf20Sopenharmony_ci *  Returns the optimal filterlist to reduce the filter handling in the
3458c2ecf20Sopenharmony_ci *  receive path. This function is called by service functions that need
3468c2ecf20Sopenharmony_ci *  to register or unregister a can_filter in the filter lists.
3478c2ecf20Sopenharmony_ci *
3488c2ecf20Sopenharmony_ci *  A filter matches in general, when
3498c2ecf20Sopenharmony_ci *
3508c2ecf20Sopenharmony_ci *          <received_can_id> & mask == can_id & mask
3518c2ecf20Sopenharmony_ci *
3528c2ecf20Sopenharmony_ci *  so every bit set in the mask (even CAN_EFF_FLAG, CAN_RTR_FLAG) describe
3538c2ecf20Sopenharmony_ci *  relevant bits for the filter.
3548c2ecf20Sopenharmony_ci *
3558c2ecf20Sopenharmony_ci *  The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
3568c2ecf20Sopenharmony_ci *  filter for error messages (CAN_ERR_FLAG bit set in mask). For error msg
3578c2ecf20Sopenharmony_ci *  frames there is a special filterlist and a special rx path filter handling.
3588c2ecf20Sopenharmony_ci *
3598c2ecf20Sopenharmony_ci * Return:
3608c2ecf20Sopenharmony_ci *  Pointer to optimal filterlist for the given can_id/mask pair.
3618c2ecf20Sopenharmony_ci *  Consistency checked mask.
3628c2ecf20Sopenharmony_ci *  Reduced can_id to have a preprocessed filter compare value.
3638c2ecf20Sopenharmony_ci */
3648c2ecf20Sopenharmony_cistatic struct hlist_head *can_rcv_list_find(canid_t *can_id, canid_t *mask,
3658c2ecf20Sopenharmony_ci					    struct can_dev_rcv_lists *dev_rcv_lists)
3668c2ecf20Sopenharmony_ci{
3678c2ecf20Sopenharmony_ci	canid_t inv = *can_id & CAN_INV_FILTER; /* save flag before masking */
3688c2ecf20Sopenharmony_ci
3698c2ecf20Sopenharmony_ci	/* filter for error message frames in extra filterlist */
3708c2ecf20Sopenharmony_ci	if (*mask & CAN_ERR_FLAG) {
3718c2ecf20Sopenharmony_ci		/* clear CAN_ERR_FLAG in filter entry */
3728c2ecf20Sopenharmony_ci		*mask &= CAN_ERR_MASK;
3738c2ecf20Sopenharmony_ci		return &dev_rcv_lists->rx[RX_ERR];
3748c2ecf20Sopenharmony_ci	}
3758c2ecf20Sopenharmony_ci
3768c2ecf20Sopenharmony_ci	/* with cleared CAN_ERR_FLAG we have a simple mask/value filterpair */
3778c2ecf20Sopenharmony_ci
3788c2ecf20Sopenharmony_ci#define CAN_EFF_RTR_FLAGS (CAN_EFF_FLAG | CAN_RTR_FLAG)
3798c2ecf20Sopenharmony_ci
3808c2ecf20Sopenharmony_ci	/* ensure valid values in can_mask for 'SFF only' frame filtering */
3818c2ecf20Sopenharmony_ci	if ((*mask & CAN_EFF_FLAG) && !(*can_id & CAN_EFF_FLAG))
3828c2ecf20Sopenharmony_ci		*mask &= (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS);
3838c2ecf20Sopenharmony_ci
3848c2ecf20Sopenharmony_ci	/* reduce condition testing at receive time */
3858c2ecf20Sopenharmony_ci	*can_id &= *mask;
3868c2ecf20Sopenharmony_ci
3878c2ecf20Sopenharmony_ci	/* inverse can_id/can_mask filter */
3888c2ecf20Sopenharmony_ci	if (inv)
3898c2ecf20Sopenharmony_ci		return &dev_rcv_lists->rx[RX_INV];
3908c2ecf20Sopenharmony_ci
3918c2ecf20Sopenharmony_ci	/* mask == 0 => no condition testing at receive time */
3928c2ecf20Sopenharmony_ci	if (!(*mask))
3938c2ecf20Sopenharmony_ci		return &dev_rcv_lists->rx[RX_ALL];
3948c2ecf20Sopenharmony_ci
3958c2ecf20Sopenharmony_ci	/* extra filterlists for the subscription of a single non-RTR can_id */
3968c2ecf20Sopenharmony_ci	if (((*mask & CAN_EFF_RTR_FLAGS) == CAN_EFF_RTR_FLAGS) &&
3978c2ecf20Sopenharmony_ci	    !(*can_id & CAN_RTR_FLAG)) {
3988c2ecf20Sopenharmony_ci		if (*can_id & CAN_EFF_FLAG) {
3998c2ecf20Sopenharmony_ci			if (*mask == (CAN_EFF_MASK | CAN_EFF_RTR_FLAGS))
4008c2ecf20Sopenharmony_ci				return &dev_rcv_lists->rx_eff[effhash(*can_id)];
4018c2ecf20Sopenharmony_ci		} else {
4028c2ecf20Sopenharmony_ci			if (*mask == (CAN_SFF_MASK | CAN_EFF_RTR_FLAGS))
4038c2ecf20Sopenharmony_ci				return &dev_rcv_lists->rx_sff[*can_id];
4048c2ecf20Sopenharmony_ci		}
4058c2ecf20Sopenharmony_ci	}
4068c2ecf20Sopenharmony_ci
4078c2ecf20Sopenharmony_ci	/* default: filter via can_id/can_mask */
4088c2ecf20Sopenharmony_ci	return &dev_rcv_lists->rx[RX_FIL];
4098c2ecf20Sopenharmony_ci}
4108c2ecf20Sopenharmony_ci
4118c2ecf20Sopenharmony_ci/**
4128c2ecf20Sopenharmony_ci * can_rx_register - subscribe CAN frames from a specific interface
4138c2ecf20Sopenharmony_ci * @net: the applicable net namespace
4148c2ecf20Sopenharmony_ci * @dev: pointer to netdevice (NULL => subscribe from 'all' CAN devices list)
4158c2ecf20Sopenharmony_ci * @can_id: CAN identifier (see description)
4168c2ecf20Sopenharmony_ci * @mask: CAN mask (see description)
4178c2ecf20Sopenharmony_ci * @func: callback function on filter match
4188c2ecf20Sopenharmony_ci * @data: returned parameter for callback function
4198c2ecf20Sopenharmony_ci * @ident: string for calling module identification
4208c2ecf20Sopenharmony_ci * @sk: socket pointer (might be NULL)
4218c2ecf20Sopenharmony_ci *
4228c2ecf20Sopenharmony_ci * Description:
4238c2ecf20Sopenharmony_ci *  Invokes the callback function with the received sk_buff and the given
4248c2ecf20Sopenharmony_ci *  parameter 'data' on a matching receive filter. A filter matches, when
4258c2ecf20Sopenharmony_ci *
4268c2ecf20Sopenharmony_ci *          <received_can_id> & mask == can_id & mask
4278c2ecf20Sopenharmony_ci *
4288c2ecf20Sopenharmony_ci *  The filter can be inverted (CAN_INV_FILTER bit set in can_id) or it can
4298c2ecf20Sopenharmony_ci *  filter for error message frames (CAN_ERR_FLAG bit set in mask).
4308c2ecf20Sopenharmony_ci *
4318c2ecf20Sopenharmony_ci *  The provided pointer to the sk_buff is guaranteed to be valid as long as
4328c2ecf20Sopenharmony_ci *  the callback function is running. The callback function must *not* free
4338c2ecf20Sopenharmony_ci *  the given sk_buff while processing it's task. When the given sk_buff is
4348c2ecf20Sopenharmony_ci *  needed after the end of the callback function it must be cloned inside
4358c2ecf20Sopenharmony_ci *  the callback function with skb_clone().
4368c2ecf20Sopenharmony_ci *
4378c2ecf20Sopenharmony_ci * Return:
4388c2ecf20Sopenharmony_ci *  0 on success
4398c2ecf20Sopenharmony_ci *  -ENOMEM on missing cache mem to create subscription entry
4408c2ecf20Sopenharmony_ci *  -ENODEV unknown device
4418c2ecf20Sopenharmony_ci */
4428c2ecf20Sopenharmony_ciint can_rx_register(struct net *net, struct net_device *dev, canid_t can_id,
4438c2ecf20Sopenharmony_ci		    canid_t mask, void (*func)(struct sk_buff *, void *),
4448c2ecf20Sopenharmony_ci		    void *data, char *ident, struct sock *sk)
4458c2ecf20Sopenharmony_ci{
4468c2ecf20Sopenharmony_ci	struct receiver *rcv;
4478c2ecf20Sopenharmony_ci	struct hlist_head *rcv_list;
4488c2ecf20Sopenharmony_ci	struct can_dev_rcv_lists *dev_rcv_lists;
4498c2ecf20Sopenharmony_ci	struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
4508c2ecf20Sopenharmony_ci	int err = 0;
4518c2ecf20Sopenharmony_ci
4528c2ecf20Sopenharmony_ci	/* insert new receiver  (dev,canid,mask) -> (func,data) */
4538c2ecf20Sopenharmony_ci
4548c2ecf20Sopenharmony_ci	if (dev && (dev->type != ARPHRD_CAN || !can_get_ml_priv(dev)))
4558c2ecf20Sopenharmony_ci		return -ENODEV;
4568c2ecf20Sopenharmony_ci
4578c2ecf20Sopenharmony_ci	if (dev && !net_eq(net, dev_net(dev)))
4588c2ecf20Sopenharmony_ci		return -ENODEV;
4598c2ecf20Sopenharmony_ci
4608c2ecf20Sopenharmony_ci	rcv = kmem_cache_alloc(rcv_cache, GFP_KERNEL);
4618c2ecf20Sopenharmony_ci	if (!rcv)
4628c2ecf20Sopenharmony_ci		return -ENOMEM;
4638c2ecf20Sopenharmony_ci
4648c2ecf20Sopenharmony_ci	spin_lock_bh(&net->can.rcvlists_lock);
4658c2ecf20Sopenharmony_ci
4668c2ecf20Sopenharmony_ci	dev_rcv_lists = can_dev_rcv_lists_find(net, dev);
4678c2ecf20Sopenharmony_ci	rcv_list = can_rcv_list_find(&can_id, &mask, dev_rcv_lists);
4688c2ecf20Sopenharmony_ci
4698c2ecf20Sopenharmony_ci	rcv->can_id = can_id;
4708c2ecf20Sopenharmony_ci	rcv->mask = mask;
4718c2ecf20Sopenharmony_ci	rcv->matches = 0;
4728c2ecf20Sopenharmony_ci	rcv->func = func;
4738c2ecf20Sopenharmony_ci	rcv->data = data;
4748c2ecf20Sopenharmony_ci	rcv->ident = ident;
4758c2ecf20Sopenharmony_ci	rcv->sk = sk;
4768c2ecf20Sopenharmony_ci
4778c2ecf20Sopenharmony_ci	hlist_add_head_rcu(&rcv->list, rcv_list);
4788c2ecf20Sopenharmony_ci	dev_rcv_lists->entries++;
4798c2ecf20Sopenharmony_ci
4808c2ecf20Sopenharmony_ci	rcv_lists_stats->rcv_entries++;
4818c2ecf20Sopenharmony_ci	rcv_lists_stats->rcv_entries_max = max(rcv_lists_stats->rcv_entries_max,
4828c2ecf20Sopenharmony_ci					       rcv_lists_stats->rcv_entries);
4838c2ecf20Sopenharmony_ci	spin_unlock_bh(&net->can.rcvlists_lock);
4848c2ecf20Sopenharmony_ci
4858c2ecf20Sopenharmony_ci	return err;
4868c2ecf20Sopenharmony_ci}
4878c2ecf20Sopenharmony_ciEXPORT_SYMBOL(can_rx_register);
4888c2ecf20Sopenharmony_ci
4898c2ecf20Sopenharmony_ci/* can_rx_delete_receiver - rcu callback for single receiver entry removal */
4908c2ecf20Sopenharmony_cistatic void can_rx_delete_receiver(struct rcu_head *rp)
4918c2ecf20Sopenharmony_ci{
4928c2ecf20Sopenharmony_ci	struct receiver *rcv = container_of(rp, struct receiver, rcu);
4938c2ecf20Sopenharmony_ci	struct sock *sk = rcv->sk;
4948c2ecf20Sopenharmony_ci
4958c2ecf20Sopenharmony_ci	kmem_cache_free(rcv_cache, rcv);
4968c2ecf20Sopenharmony_ci	if (sk)
4978c2ecf20Sopenharmony_ci		sock_put(sk);
4988c2ecf20Sopenharmony_ci}
4998c2ecf20Sopenharmony_ci
5008c2ecf20Sopenharmony_ci/**
5018c2ecf20Sopenharmony_ci * can_rx_unregister - unsubscribe CAN frames from a specific interface
5028c2ecf20Sopenharmony_ci * @net: the applicable net namespace
5038c2ecf20Sopenharmony_ci * @dev: pointer to netdevice (NULL => unsubscribe from 'all' CAN devices list)
5048c2ecf20Sopenharmony_ci * @can_id: CAN identifier
5058c2ecf20Sopenharmony_ci * @mask: CAN mask
5068c2ecf20Sopenharmony_ci * @func: callback function on filter match
5078c2ecf20Sopenharmony_ci * @data: returned parameter for callback function
5088c2ecf20Sopenharmony_ci *
5098c2ecf20Sopenharmony_ci * Description:
5108c2ecf20Sopenharmony_ci *  Removes subscription entry depending on given (subscription) values.
5118c2ecf20Sopenharmony_ci */
5128c2ecf20Sopenharmony_civoid can_rx_unregister(struct net *net, struct net_device *dev, canid_t can_id,
5138c2ecf20Sopenharmony_ci		       canid_t mask, void (*func)(struct sk_buff *, void *),
5148c2ecf20Sopenharmony_ci		       void *data)
5158c2ecf20Sopenharmony_ci{
5168c2ecf20Sopenharmony_ci	struct receiver *rcv = NULL;
5178c2ecf20Sopenharmony_ci	struct hlist_head *rcv_list;
5188c2ecf20Sopenharmony_ci	struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
5198c2ecf20Sopenharmony_ci	struct can_dev_rcv_lists *dev_rcv_lists;
5208c2ecf20Sopenharmony_ci
5218c2ecf20Sopenharmony_ci	if (dev && dev->type != ARPHRD_CAN)
5228c2ecf20Sopenharmony_ci		return;
5238c2ecf20Sopenharmony_ci
5248c2ecf20Sopenharmony_ci	if (dev && !net_eq(net, dev_net(dev)))
5258c2ecf20Sopenharmony_ci		return;
5268c2ecf20Sopenharmony_ci
5278c2ecf20Sopenharmony_ci	spin_lock_bh(&net->can.rcvlists_lock);
5288c2ecf20Sopenharmony_ci
5298c2ecf20Sopenharmony_ci	dev_rcv_lists = can_dev_rcv_lists_find(net, dev);
5308c2ecf20Sopenharmony_ci	rcv_list = can_rcv_list_find(&can_id, &mask, dev_rcv_lists);
5318c2ecf20Sopenharmony_ci
5328c2ecf20Sopenharmony_ci	/* Search the receiver list for the item to delete.  This should
5338c2ecf20Sopenharmony_ci	 * exist, since no receiver may be unregistered that hasn't
5348c2ecf20Sopenharmony_ci	 * been registered before.
5358c2ecf20Sopenharmony_ci	 */
5368c2ecf20Sopenharmony_ci	hlist_for_each_entry_rcu(rcv, rcv_list, list) {
5378c2ecf20Sopenharmony_ci		if (rcv->can_id == can_id && rcv->mask == mask &&
5388c2ecf20Sopenharmony_ci		    rcv->func == func && rcv->data == data)
5398c2ecf20Sopenharmony_ci			break;
5408c2ecf20Sopenharmony_ci	}
5418c2ecf20Sopenharmony_ci
5428c2ecf20Sopenharmony_ci	/* Check for bugs in CAN protocol implementations using af_can.c:
5438c2ecf20Sopenharmony_ci	 * 'rcv' will be NULL if no matching list item was found for removal.
5448c2ecf20Sopenharmony_ci	 * As this case may potentially happen when closing a socket while
5458c2ecf20Sopenharmony_ci	 * the notifier for removing the CAN netdev is running we just print
5468c2ecf20Sopenharmony_ci	 * a warning here.
5478c2ecf20Sopenharmony_ci	 */
5488c2ecf20Sopenharmony_ci	if (!rcv) {
5498c2ecf20Sopenharmony_ci		pr_warn("can: receive list entry not found for dev %s, id %03X, mask %03X\n",
5508c2ecf20Sopenharmony_ci			DNAME(dev), can_id, mask);
5518c2ecf20Sopenharmony_ci		goto out;
5528c2ecf20Sopenharmony_ci	}
5538c2ecf20Sopenharmony_ci
5548c2ecf20Sopenharmony_ci	hlist_del_rcu(&rcv->list);
5558c2ecf20Sopenharmony_ci	dev_rcv_lists->entries--;
5568c2ecf20Sopenharmony_ci
5578c2ecf20Sopenharmony_ci	if (rcv_lists_stats->rcv_entries > 0)
5588c2ecf20Sopenharmony_ci		rcv_lists_stats->rcv_entries--;
5598c2ecf20Sopenharmony_ci
5608c2ecf20Sopenharmony_ci out:
5618c2ecf20Sopenharmony_ci	spin_unlock_bh(&net->can.rcvlists_lock);
5628c2ecf20Sopenharmony_ci
5638c2ecf20Sopenharmony_ci	/* schedule the receiver item for deletion */
5648c2ecf20Sopenharmony_ci	if (rcv) {
5658c2ecf20Sopenharmony_ci		if (rcv->sk)
5668c2ecf20Sopenharmony_ci			sock_hold(rcv->sk);
5678c2ecf20Sopenharmony_ci		call_rcu(&rcv->rcu, can_rx_delete_receiver);
5688c2ecf20Sopenharmony_ci	}
5698c2ecf20Sopenharmony_ci}
5708c2ecf20Sopenharmony_ciEXPORT_SYMBOL(can_rx_unregister);
5718c2ecf20Sopenharmony_ci
5728c2ecf20Sopenharmony_cistatic inline void deliver(struct sk_buff *skb, struct receiver *rcv)
5738c2ecf20Sopenharmony_ci{
5748c2ecf20Sopenharmony_ci	rcv->func(skb, rcv->data);
5758c2ecf20Sopenharmony_ci	rcv->matches++;
5768c2ecf20Sopenharmony_ci}
5778c2ecf20Sopenharmony_ci
5788c2ecf20Sopenharmony_cistatic int can_rcv_filter(struct can_dev_rcv_lists *dev_rcv_lists, struct sk_buff *skb)
5798c2ecf20Sopenharmony_ci{
5808c2ecf20Sopenharmony_ci	struct receiver *rcv;
5818c2ecf20Sopenharmony_ci	int matches = 0;
5828c2ecf20Sopenharmony_ci	struct can_frame *cf = (struct can_frame *)skb->data;
5838c2ecf20Sopenharmony_ci	canid_t can_id = cf->can_id;
5848c2ecf20Sopenharmony_ci
5858c2ecf20Sopenharmony_ci	if (dev_rcv_lists->entries == 0)
5868c2ecf20Sopenharmony_ci		return 0;
5878c2ecf20Sopenharmony_ci
5888c2ecf20Sopenharmony_ci	if (can_id & CAN_ERR_FLAG) {
5898c2ecf20Sopenharmony_ci		/* check for error message frame entries only */
5908c2ecf20Sopenharmony_ci		hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_ERR], list) {
5918c2ecf20Sopenharmony_ci			if (can_id & rcv->mask) {
5928c2ecf20Sopenharmony_ci				deliver(skb, rcv);
5938c2ecf20Sopenharmony_ci				matches++;
5948c2ecf20Sopenharmony_ci			}
5958c2ecf20Sopenharmony_ci		}
5968c2ecf20Sopenharmony_ci		return matches;
5978c2ecf20Sopenharmony_ci	}
5988c2ecf20Sopenharmony_ci
5998c2ecf20Sopenharmony_ci	/* check for unfiltered entries */
6008c2ecf20Sopenharmony_ci	hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_ALL], list) {
6018c2ecf20Sopenharmony_ci		deliver(skb, rcv);
6028c2ecf20Sopenharmony_ci		matches++;
6038c2ecf20Sopenharmony_ci	}
6048c2ecf20Sopenharmony_ci
6058c2ecf20Sopenharmony_ci	/* check for can_id/mask entries */
6068c2ecf20Sopenharmony_ci	hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_FIL], list) {
6078c2ecf20Sopenharmony_ci		if ((can_id & rcv->mask) == rcv->can_id) {
6088c2ecf20Sopenharmony_ci			deliver(skb, rcv);
6098c2ecf20Sopenharmony_ci			matches++;
6108c2ecf20Sopenharmony_ci		}
6118c2ecf20Sopenharmony_ci	}
6128c2ecf20Sopenharmony_ci
6138c2ecf20Sopenharmony_ci	/* check for inverted can_id/mask entries */
6148c2ecf20Sopenharmony_ci	hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx[RX_INV], list) {
6158c2ecf20Sopenharmony_ci		if ((can_id & rcv->mask) != rcv->can_id) {
6168c2ecf20Sopenharmony_ci			deliver(skb, rcv);
6178c2ecf20Sopenharmony_ci			matches++;
6188c2ecf20Sopenharmony_ci		}
6198c2ecf20Sopenharmony_ci	}
6208c2ecf20Sopenharmony_ci
6218c2ecf20Sopenharmony_ci	/* check filterlists for single non-RTR can_ids */
6228c2ecf20Sopenharmony_ci	if (can_id & CAN_RTR_FLAG)
6238c2ecf20Sopenharmony_ci		return matches;
6248c2ecf20Sopenharmony_ci
6258c2ecf20Sopenharmony_ci	if (can_id & CAN_EFF_FLAG) {
6268c2ecf20Sopenharmony_ci		hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx_eff[effhash(can_id)], list) {
6278c2ecf20Sopenharmony_ci			if (rcv->can_id == can_id) {
6288c2ecf20Sopenharmony_ci				deliver(skb, rcv);
6298c2ecf20Sopenharmony_ci				matches++;
6308c2ecf20Sopenharmony_ci			}
6318c2ecf20Sopenharmony_ci		}
6328c2ecf20Sopenharmony_ci	} else {
6338c2ecf20Sopenharmony_ci		can_id &= CAN_SFF_MASK;
6348c2ecf20Sopenharmony_ci		hlist_for_each_entry_rcu(rcv, &dev_rcv_lists->rx_sff[can_id], list) {
6358c2ecf20Sopenharmony_ci			deliver(skb, rcv);
6368c2ecf20Sopenharmony_ci			matches++;
6378c2ecf20Sopenharmony_ci		}
6388c2ecf20Sopenharmony_ci	}
6398c2ecf20Sopenharmony_ci
6408c2ecf20Sopenharmony_ci	return matches;
6418c2ecf20Sopenharmony_ci}
6428c2ecf20Sopenharmony_ci
6438c2ecf20Sopenharmony_cistatic void can_receive(struct sk_buff *skb, struct net_device *dev)
6448c2ecf20Sopenharmony_ci{
6458c2ecf20Sopenharmony_ci	struct can_dev_rcv_lists *dev_rcv_lists;
6468c2ecf20Sopenharmony_ci	struct net *net = dev_net(dev);
6478c2ecf20Sopenharmony_ci	struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
6488c2ecf20Sopenharmony_ci	int matches;
6498c2ecf20Sopenharmony_ci
6508c2ecf20Sopenharmony_ci	/* update statistics */
6518c2ecf20Sopenharmony_ci	pkg_stats->rx_frames++;
6528c2ecf20Sopenharmony_ci	pkg_stats->rx_frames_delta++;
6538c2ecf20Sopenharmony_ci
6548c2ecf20Sopenharmony_ci	/* create non-zero unique skb identifier together with *skb */
6558c2ecf20Sopenharmony_ci	while (!(can_skb_prv(skb)->skbcnt))
6568c2ecf20Sopenharmony_ci		can_skb_prv(skb)->skbcnt = atomic_inc_return(&skbcounter);
6578c2ecf20Sopenharmony_ci
6588c2ecf20Sopenharmony_ci	rcu_read_lock();
6598c2ecf20Sopenharmony_ci
6608c2ecf20Sopenharmony_ci	/* deliver the packet to sockets listening on all devices */
6618c2ecf20Sopenharmony_ci	matches = can_rcv_filter(net->can.rx_alldev_list, skb);
6628c2ecf20Sopenharmony_ci
6638c2ecf20Sopenharmony_ci	/* find receive list for this device */
6648c2ecf20Sopenharmony_ci	dev_rcv_lists = can_dev_rcv_lists_find(net, dev);
6658c2ecf20Sopenharmony_ci	matches += can_rcv_filter(dev_rcv_lists, skb);
6668c2ecf20Sopenharmony_ci
6678c2ecf20Sopenharmony_ci	rcu_read_unlock();
6688c2ecf20Sopenharmony_ci
6698c2ecf20Sopenharmony_ci	/* consume the skbuff allocated by the netdevice driver */
6708c2ecf20Sopenharmony_ci	consume_skb(skb);
6718c2ecf20Sopenharmony_ci
6728c2ecf20Sopenharmony_ci	if (matches > 0) {
6738c2ecf20Sopenharmony_ci		pkg_stats->matches++;
6748c2ecf20Sopenharmony_ci		pkg_stats->matches_delta++;
6758c2ecf20Sopenharmony_ci	}
6768c2ecf20Sopenharmony_ci}
6778c2ecf20Sopenharmony_ci
6788c2ecf20Sopenharmony_cistatic int can_rcv(struct sk_buff *skb, struct net_device *dev,
6798c2ecf20Sopenharmony_ci		   struct packet_type *pt, struct net_device *orig_dev)
6808c2ecf20Sopenharmony_ci{
6818c2ecf20Sopenharmony_ci	struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
6828c2ecf20Sopenharmony_ci
6838c2ecf20Sopenharmony_ci	if (unlikely(dev->type != ARPHRD_CAN || !can_get_ml_priv(dev) || skb->len != CAN_MTU)) {
6848c2ecf20Sopenharmony_ci		pr_warn_once("PF_CAN: dropped non conform CAN skbuff: dev type %d, len %d\n",
6858c2ecf20Sopenharmony_ci			     dev->type, skb->len);
6868c2ecf20Sopenharmony_ci		goto free_skb;
6878c2ecf20Sopenharmony_ci	}
6888c2ecf20Sopenharmony_ci
6898c2ecf20Sopenharmony_ci	/* This check is made separately since cfd->len would be uninitialized if skb->len = 0. */
6908c2ecf20Sopenharmony_ci	if (unlikely(cfd->len > CAN_MAX_DLEN)) {
6918c2ecf20Sopenharmony_ci		pr_warn_once("PF_CAN: dropped non conform CAN skbuff: dev type %d, len %d, datalen %d\n",
6928c2ecf20Sopenharmony_ci			     dev->type, skb->len, cfd->len);
6938c2ecf20Sopenharmony_ci		goto free_skb;
6948c2ecf20Sopenharmony_ci	}
6958c2ecf20Sopenharmony_ci
6968c2ecf20Sopenharmony_ci	can_receive(skb, dev);
6978c2ecf20Sopenharmony_ci	return NET_RX_SUCCESS;
6988c2ecf20Sopenharmony_ci
6998c2ecf20Sopenharmony_cifree_skb:
7008c2ecf20Sopenharmony_ci	kfree_skb(skb);
7018c2ecf20Sopenharmony_ci	return NET_RX_DROP;
7028c2ecf20Sopenharmony_ci}
7038c2ecf20Sopenharmony_ci
7048c2ecf20Sopenharmony_cistatic int canfd_rcv(struct sk_buff *skb, struct net_device *dev,
7058c2ecf20Sopenharmony_ci		     struct packet_type *pt, struct net_device *orig_dev)
7068c2ecf20Sopenharmony_ci{
7078c2ecf20Sopenharmony_ci	struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
7088c2ecf20Sopenharmony_ci
7098c2ecf20Sopenharmony_ci	if (unlikely(dev->type != ARPHRD_CAN || !can_get_ml_priv(dev) || skb->len != CANFD_MTU)) {
7108c2ecf20Sopenharmony_ci		pr_warn_once("PF_CAN: dropped non conform CAN FD skbuff: dev type %d, len %d\n",
7118c2ecf20Sopenharmony_ci			     dev->type, skb->len);
7128c2ecf20Sopenharmony_ci		goto free_skb;
7138c2ecf20Sopenharmony_ci	}
7148c2ecf20Sopenharmony_ci
7158c2ecf20Sopenharmony_ci	/* This check is made separately since cfd->len would be uninitialized if skb->len = 0. */
7168c2ecf20Sopenharmony_ci	if (unlikely(cfd->len > CANFD_MAX_DLEN)) {
7178c2ecf20Sopenharmony_ci		pr_warn_once("PF_CAN: dropped non conform CAN FD skbuff: dev type %d, len %d, datalen %d\n",
7188c2ecf20Sopenharmony_ci			     dev->type, skb->len, cfd->len);
7198c2ecf20Sopenharmony_ci		goto free_skb;
7208c2ecf20Sopenharmony_ci	}
7218c2ecf20Sopenharmony_ci
7228c2ecf20Sopenharmony_ci	can_receive(skb, dev);
7238c2ecf20Sopenharmony_ci	return NET_RX_SUCCESS;
7248c2ecf20Sopenharmony_ci
7258c2ecf20Sopenharmony_cifree_skb:
7268c2ecf20Sopenharmony_ci	kfree_skb(skb);
7278c2ecf20Sopenharmony_ci	return NET_RX_DROP;
7288c2ecf20Sopenharmony_ci}
7298c2ecf20Sopenharmony_ci
7308c2ecf20Sopenharmony_ci/* af_can protocol functions */
7318c2ecf20Sopenharmony_ci
7328c2ecf20Sopenharmony_ci/**
7338c2ecf20Sopenharmony_ci * can_proto_register - register CAN transport protocol
7348c2ecf20Sopenharmony_ci * @cp: pointer to CAN protocol structure
7358c2ecf20Sopenharmony_ci *
7368c2ecf20Sopenharmony_ci * Return:
7378c2ecf20Sopenharmony_ci *  0 on success
7388c2ecf20Sopenharmony_ci *  -EINVAL invalid (out of range) protocol number
7398c2ecf20Sopenharmony_ci *  -EBUSY  protocol already in use
7408c2ecf20Sopenharmony_ci *  -ENOBUF if proto_register() fails
7418c2ecf20Sopenharmony_ci */
7428c2ecf20Sopenharmony_ciint can_proto_register(const struct can_proto *cp)
7438c2ecf20Sopenharmony_ci{
7448c2ecf20Sopenharmony_ci	int proto = cp->protocol;
7458c2ecf20Sopenharmony_ci	int err = 0;
7468c2ecf20Sopenharmony_ci
7478c2ecf20Sopenharmony_ci	if (proto < 0 || proto >= CAN_NPROTO) {
7488c2ecf20Sopenharmony_ci		pr_err("can: protocol number %d out of range\n", proto);
7498c2ecf20Sopenharmony_ci		return -EINVAL;
7508c2ecf20Sopenharmony_ci	}
7518c2ecf20Sopenharmony_ci
7528c2ecf20Sopenharmony_ci	err = proto_register(cp->prot, 0);
7538c2ecf20Sopenharmony_ci	if (err < 0)
7548c2ecf20Sopenharmony_ci		return err;
7558c2ecf20Sopenharmony_ci
7568c2ecf20Sopenharmony_ci	mutex_lock(&proto_tab_lock);
7578c2ecf20Sopenharmony_ci
7588c2ecf20Sopenharmony_ci	if (rcu_access_pointer(proto_tab[proto])) {
7598c2ecf20Sopenharmony_ci		pr_err("can: protocol %d already registered\n", proto);
7608c2ecf20Sopenharmony_ci		err = -EBUSY;
7618c2ecf20Sopenharmony_ci	} else {
7628c2ecf20Sopenharmony_ci		RCU_INIT_POINTER(proto_tab[proto], cp);
7638c2ecf20Sopenharmony_ci	}
7648c2ecf20Sopenharmony_ci
7658c2ecf20Sopenharmony_ci	mutex_unlock(&proto_tab_lock);
7668c2ecf20Sopenharmony_ci
7678c2ecf20Sopenharmony_ci	if (err < 0)
7688c2ecf20Sopenharmony_ci		proto_unregister(cp->prot);
7698c2ecf20Sopenharmony_ci
7708c2ecf20Sopenharmony_ci	return err;
7718c2ecf20Sopenharmony_ci}
7728c2ecf20Sopenharmony_ciEXPORT_SYMBOL(can_proto_register);
7738c2ecf20Sopenharmony_ci
7748c2ecf20Sopenharmony_ci/**
7758c2ecf20Sopenharmony_ci * can_proto_unregister - unregister CAN transport protocol
7768c2ecf20Sopenharmony_ci * @cp: pointer to CAN protocol structure
7778c2ecf20Sopenharmony_ci */
7788c2ecf20Sopenharmony_civoid can_proto_unregister(const struct can_proto *cp)
7798c2ecf20Sopenharmony_ci{
7808c2ecf20Sopenharmony_ci	int proto = cp->protocol;
7818c2ecf20Sopenharmony_ci
7828c2ecf20Sopenharmony_ci	mutex_lock(&proto_tab_lock);
7838c2ecf20Sopenharmony_ci	BUG_ON(rcu_access_pointer(proto_tab[proto]) != cp);
7848c2ecf20Sopenharmony_ci	RCU_INIT_POINTER(proto_tab[proto], NULL);
7858c2ecf20Sopenharmony_ci	mutex_unlock(&proto_tab_lock);
7868c2ecf20Sopenharmony_ci
7878c2ecf20Sopenharmony_ci	synchronize_rcu();
7888c2ecf20Sopenharmony_ci
7898c2ecf20Sopenharmony_ci	proto_unregister(cp->prot);
7908c2ecf20Sopenharmony_ci}
7918c2ecf20Sopenharmony_ciEXPORT_SYMBOL(can_proto_unregister);
7928c2ecf20Sopenharmony_ci
7938c2ecf20Sopenharmony_cistatic int can_pernet_init(struct net *net)
7948c2ecf20Sopenharmony_ci{
7958c2ecf20Sopenharmony_ci	spin_lock_init(&net->can.rcvlists_lock);
7968c2ecf20Sopenharmony_ci	net->can.rx_alldev_list =
7978c2ecf20Sopenharmony_ci		kzalloc(sizeof(*net->can.rx_alldev_list), GFP_KERNEL);
7988c2ecf20Sopenharmony_ci	if (!net->can.rx_alldev_list)
7998c2ecf20Sopenharmony_ci		goto out;
8008c2ecf20Sopenharmony_ci	net->can.pkg_stats = kzalloc(sizeof(*net->can.pkg_stats), GFP_KERNEL);
8018c2ecf20Sopenharmony_ci	if (!net->can.pkg_stats)
8028c2ecf20Sopenharmony_ci		goto out_free_rx_alldev_list;
8038c2ecf20Sopenharmony_ci	net->can.rcv_lists_stats = kzalloc(sizeof(*net->can.rcv_lists_stats), GFP_KERNEL);
8048c2ecf20Sopenharmony_ci	if (!net->can.rcv_lists_stats)
8058c2ecf20Sopenharmony_ci		goto out_free_pkg_stats;
8068c2ecf20Sopenharmony_ci
8078c2ecf20Sopenharmony_ci	if (IS_ENABLED(CONFIG_PROC_FS)) {
8088c2ecf20Sopenharmony_ci		/* the statistics are updated every second (timer triggered) */
8098c2ecf20Sopenharmony_ci		if (stats_timer) {
8108c2ecf20Sopenharmony_ci			timer_setup(&net->can.stattimer, can_stat_update,
8118c2ecf20Sopenharmony_ci				    0);
8128c2ecf20Sopenharmony_ci			mod_timer(&net->can.stattimer,
8138c2ecf20Sopenharmony_ci				  round_jiffies(jiffies + HZ));
8148c2ecf20Sopenharmony_ci		}
8158c2ecf20Sopenharmony_ci		net->can.pkg_stats->jiffies_init = jiffies;
8168c2ecf20Sopenharmony_ci		can_init_proc(net);
8178c2ecf20Sopenharmony_ci	}
8188c2ecf20Sopenharmony_ci
8198c2ecf20Sopenharmony_ci	return 0;
8208c2ecf20Sopenharmony_ci
8218c2ecf20Sopenharmony_ci out_free_pkg_stats:
8228c2ecf20Sopenharmony_ci	kfree(net->can.pkg_stats);
8238c2ecf20Sopenharmony_ci out_free_rx_alldev_list:
8248c2ecf20Sopenharmony_ci	kfree(net->can.rx_alldev_list);
8258c2ecf20Sopenharmony_ci out:
8268c2ecf20Sopenharmony_ci	return -ENOMEM;
8278c2ecf20Sopenharmony_ci}
8288c2ecf20Sopenharmony_ci
8298c2ecf20Sopenharmony_cistatic void can_pernet_exit(struct net *net)
8308c2ecf20Sopenharmony_ci{
8318c2ecf20Sopenharmony_ci	if (IS_ENABLED(CONFIG_PROC_FS)) {
8328c2ecf20Sopenharmony_ci		can_remove_proc(net);
8338c2ecf20Sopenharmony_ci		if (stats_timer)
8348c2ecf20Sopenharmony_ci			del_timer_sync(&net->can.stattimer);
8358c2ecf20Sopenharmony_ci	}
8368c2ecf20Sopenharmony_ci
8378c2ecf20Sopenharmony_ci	kfree(net->can.rx_alldev_list);
8388c2ecf20Sopenharmony_ci	kfree(net->can.pkg_stats);
8398c2ecf20Sopenharmony_ci	kfree(net->can.rcv_lists_stats);
8408c2ecf20Sopenharmony_ci}
8418c2ecf20Sopenharmony_ci
8428c2ecf20Sopenharmony_ci/* af_can module init/exit functions */
8438c2ecf20Sopenharmony_ci
8448c2ecf20Sopenharmony_cistatic struct packet_type can_packet __read_mostly = {
8458c2ecf20Sopenharmony_ci	.type = cpu_to_be16(ETH_P_CAN),
8468c2ecf20Sopenharmony_ci	.func = can_rcv,
8478c2ecf20Sopenharmony_ci};
8488c2ecf20Sopenharmony_ci
8498c2ecf20Sopenharmony_cistatic struct packet_type canfd_packet __read_mostly = {
8508c2ecf20Sopenharmony_ci	.type = cpu_to_be16(ETH_P_CANFD),
8518c2ecf20Sopenharmony_ci	.func = canfd_rcv,
8528c2ecf20Sopenharmony_ci};
8538c2ecf20Sopenharmony_ci
8548c2ecf20Sopenharmony_cistatic const struct net_proto_family can_family_ops = {
8558c2ecf20Sopenharmony_ci	.family = PF_CAN,
8568c2ecf20Sopenharmony_ci	.create = can_create,
8578c2ecf20Sopenharmony_ci	.owner  = THIS_MODULE,
8588c2ecf20Sopenharmony_ci};
8598c2ecf20Sopenharmony_ci
8608c2ecf20Sopenharmony_cistatic struct pernet_operations can_pernet_ops __read_mostly = {
8618c2ecf20Sopenharmony_ci	.init = can_pernet_init,
8628c2ecf20Sopenharmony_ci	.exit = can_pernet_exit,
8638c2ecf20Sopenharmony_ci};
8648c2ecf20Sopenharmony_ci
8658c2ecf20Sopenharmony_cistatic __init int can_init(void)
8668c2ecf20Sopenharmony_ci{
8678c2ecf20Sopenharmony_ci	int err;
8688c2ecf20Sopenharmony_ci
8698c2ecf20Sopenharmony_ci	/* check for correct padding to be able to use the structs similarly */
8708c2ecf20Sopenharmony_ci	BUILD_BUG_ON(offsetof(struct can_frame, can_dlc) !=
8718c2ecf20Sopenharmony_ci		     offsetof(struct canfd_frame, len) ||
8728c2ecf20Sopenharmony_ci		     offsetof(struct can_frame, data) !=
8738c2ecf20Sopenharmony_ci		     offsetof(struct canfd_frame, data));
8748c2ecf20Sopenharmony_ci
8758c2ecf20Sopenharmony_ci	pr_info("can: controller area network core\n");
8768c2ecf20Sopenharmony_ci
8778c2ecf20Sopenharmony_ci	rcv_cache = kmem_cache_create("can_receiver", sizeof(struct receiver),
8788c2ecf20Sopenharmony_ci				      0, 0, NULL);
8798c2ecf20Sopenharmony_ci	if (!rcv_cache)
8808c2ecf20Sopenharmony_ci		return -ENOMEM;
8818c2ecf20Sopenharmony_ci
8828c2ecf20Sopenharmony_ci	err = register_pernet_subsys(&can_pernet_ops);
8838c2ecf20Sopenharmony_ci	if (err)
8848c2ecf20Sopenharmony_ci		goto out_pernet;
8858c2ecf20Sopenharmony_ci
8868c2ecf20Sopenharmony_ci	/* protocol register */
8878c2ecf20Sopenharmony_ci	err = sock_register(&can_family_ops);
8888c2ecf20Sopenharmony_ci	if (err)
8898c2ecf20Sopenharmony_ci		goto out_sock;
8908c2ecf20Sopenharmony_ci
8918c2ecf20Sopenharmony_ci	dev_add_pack(&can_packet);
8928c2ecf20Sopenharmony_ci	dev_add_pack(&canfd_packet);
8938c2ecf20Sopenharmony_ci
8948c2ecf20Sopenharmony_ci	return 0;
8958c2ecf20Sopenharmony_ci
8968c2ecf20Sopenharmony_ciout_sock:
8978c2ecf20Sopenharmony_ci	unregister_pernet_subsys(&can_pernet_ops);
8988c2ecf20Sopenharmony_ciout_pernet:
8998c2ecf20Sopenharmony_ci	kmem_cache_destroy(rcv_cache);
9008c2ecf20Sopenharmony_ci
9018c2ecf20Sopenharmony_ci	return err;
9028c2ecf20Sopenharmony_ci}
9038c2ecf20Sopenharmony_ci
9048c2ecf20Sopenharmony_cistatic __exit void can_exit(void)
9058c2ecf20Sopenharmony_ci{
9068c2ecf20Sopenharmony_ci	/* protocol unregister */
9078c2ecf20Sopenharmony_ci	dev_remove_pack(&canfd_packet);
9088c2ecf20Sopenharmony_ci	dev_remove_pack(&can_packet);
9098c2ecf20Sopenharmony_ci	sock_unregister(PF_CAN);
9108c2ecf20Sopenharmony_ci
9118c2ecf20Sopenharmony_ci	unregister_pernet_subsys(&can_pernet_ops);
9128c2ecf20Sopenharmony_ci
9138c2ecf20Sopenharmony_ci	rcu_barrier(); /* Wait for completion of call_rcu()'s */
9148c2ecf20Sopenharmony_ci
9158c2ecf20Sopenharmony_ci	kmem_cache_destroy(rcv_cache);
9168c2ecf20Sopenharmony_ci}
9178c2ecf20Sopenharmony_ci
9188c2ecf20Sopenharmony_cimodule_init(can_init);
9198c2ecf20Sopenharmony_cimodule_exit(can_exit);
920