1 /* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
2 /* Copyright (c) 2002-2007 Volkswagen Group Electronic Research
3 * Copyright (c) 2017 Pengutronix, Marc Kleine-Budde <kernel@pengutronix.de>
4 *
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of Volkswagen nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * Alternatively, provided that this notice is retained in full, this
20 * software may be distributed under the terms of the GNU General
21 * Public License ("GPL") version 2, in which case the provisions of the
22 * GPL apply INSTEAD OF those given above.
23 *
24 * The provided data structures and external interfaces from this code
25 * are not restricted to be used by modules with a GPL compatible license.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
38 * DAMAGE.
39 *
40 */
41
42 #ifndef CAN_ML_H
43 #define CAN_ML_H
44
45 #include <linux/can.h>
46 #include <linux/list.h>
47 #include <linux/netdevice.h>
48
49 /* exposed CAN device capabilities for network layer */
50 #define CAN_CAP_CC BIT(0) /* CAN CC aka Classical CAN */
51 #define CAN_CAP_FD BIT(1) /* CAN FD */
52 #define CAN_CAP_XL BIT(2) /* CAN XL */
53 #define CAN_CAP_RO BIT(3) /* read-only mode (LISTEN/RESTRICTED) */
54
55 #define CAN_SFF_RCV_ARRAY_SZ (1 << CAN_SFF_ID_BITS)
56 #define CAN_EFF_RCV_HASH_BITS 10
57 #define CAN_EFF_RCV_ARRAY_SZ (1 << CAN_EFF_RCV_HASH_BITS)
58
59 enum { RX_ERR, RX_ALL, RX_FIL, RX_INV, RX_MAX };
60
61 struct can_dev_rcv_lists {
62 struct hlist_head rx[RX_MAX];
63 struct hlist_head rx_sff[CAN_SFF_RCV_ARRAY_SZ];
64 struct hlist_head rx_eff[CAN_EFF_RCV_ARRAY_SZ];
65 int entries;
66 };
67
68 struct can_ml_priv {
69 struct can_dev_rcv_lists dev_rcv_lists;
70 #ifdef CAN_J1939
71 struct j1939_priv *j1939_priv;
72 #endif
73 u32 can_cap;
74 };
75
can_get_ml_priv(struct net_device * dev)76 static inline struct can_ml_priv *can_get_ml_priv(struct net_device *dev)
77 {
78 return netdev_get_ml_priv(dev, ML_PRIV_CAN);
79 }
80
can_set_ml_priv(struct net_device * dev,struct can_ml_priv * ml_priv)81 static inline void can_set_ml_priv(struct net_device *dev,
82 struct can_ml_priv *ml_priv)
83 {
84 netdev_set_ml_priv(dev, ml_priv, ML_PRIV_CAN);
85 }
86
can_cap_enabled(struct net_device * dev,u32 cap)87 static inline bool can_cap_enabled(struct net_device *dev, u32 cap)
88 {
89 struct can_ml_priv *can_ml = can_get_ml_priv(dev);
90
91 if (!can_ml)
92 return false;
93
94 return (can_ml->can_cap & cap);
95 }
96
can_set_cap(struct net_device * dev,u32 cap)97 static inline void can_set_cap(struct net_device *dev, u32 cap)
98 {
99 struct can_ml_priv *can_ml = can_get_ml_priv(dev);
100
101 can_ml->can_cap = cap;
102 }
103
104 #endif /* CAN_ML_H */
105