blob: 6992afc6ba7f96fda9dba202f771fe7e28f807fe [file] [log] [blame]
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +00001/*
2 * linux/can/dev.h
3 *
4 * Definitions for the CAN network device driver interface
5 *
6 * Copyright (C) 2006 Andrey Volkov <avolkov@varma-el.com>
7 * Varma Electronics Oy
8 *
9 * Copyright (C) 2008 Wolfgang Grandegger <wg@grandegger.com>
10 *
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +000011 */
12
Oliver Hartkopp42193e32014-05-15 20:31:56 +020013#ifndef _CAN_DEV_H
14#define _CAN_DEV_H
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +000015
Hans J. Koch829e0012010-04-13 00:03:25 +000016#include <linux/can.h>
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +000017#include <linux/can/netlink.h>
18#include <linux/can/error.h>
Fabio Baltieri996a9532012-12-18 18:50:55 +010019#include <linux/can/led.h>
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +000020
21/*
22 * CAN mode
23 */
24enum can_mode {
25 CAN_MODE_STOP = 0,
26 CAN_MODE_START,
27 CAN_MODE_SLEEP
28};
29
30/*
31 * CAN common private data
32 */
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +000033struct can_priv {
34 struct can_device_stats can_stats;
35
Oliver Hartkopp9859ccd2014-02-28 16:36:23 +010036 struct can_bittiming bittiming, data_bittiming;
37 const struct can_bittiming_const *bittiming_const,
38 *data_bittiming_const;
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +000039 struct can_clock clock;
40
41 enum can_state state;
42 u32 ctrlmode;
Christian Pellegrinad72c342010-01-14 07:08:34 +000043 u32 ctrlmode_supported;
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +000044
45 int restart_ms;
46 struct timer_list restart_timer;
47
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +000048 int (*do_set_bittiming)(struct net_device *dev);
Oliver Hartkopp9859ccd2014-02-28 16:36:23 +010049 int (*do_set_data_bittiming)(struct net_device *dev);
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +000050 int (*do_set_mode)(struct net_device *dev, enum can_mode mode);
51 int (*do_get_state)(const struct net_device *dev,
52 enum can_state *state);
Wolfgang Grandegger52c793f2010-02-22 22:21:17 +000053 int (*do_get_berr_counter)(const struct net_device *dev,
54 struct can_berr_counter *bec);
Wolfgang Grandeggera6e4bc52009-10-08 22:17:11 +000055
56 unsigned int echo_skb_max;
57 struct sk_buff **echo_skb;
Fabio Baltieri996a9532012-12-18 18:50:55 +010058
59#ifdef CONFIG_CAN_LEDS
60 struct led_trigger *tx_led_trig;
61 char tx_led_trig_name[CAN_LED_NAME_SZ];
62 struct led_trigger *rx_led_trig;
63 char rx_led_trig_name[CAN_LED_NAME_SZ];
64#endif
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +000065};
66
Oliver Hartkoppc7cd6062009-12-12 04:13:21 +000067/*
68 * get_can_dlc(value) - helper macro to cast a given data length code (dlc)
69 * to __u8 and ensure the dlc value to be max. 8 bytes.
70 *
71 * To be used in the CAN netdriver receive path to ensure conformance with
72 * ISO 11898-1 Chapter 8.4.2.3 (DLC field)
73 */
Oliver Hartkopp1e0625f2012-06-13 20:48:21 +020074#define get_can_dlc(i) (min_t(__u8, (i), CAN_MAX_DLC))
75#define get_canfd_dlc(i) (min_t(__u8, (i), CANFD_MAX_DLC))
Oliver Hartkoppc7cd6062009-12-12 04:13:21 +000076
Oliver Hartkopp3ccd4c62010-01-12 02:00:46 -080077/* Drop a given socketbuffer if it does not contain a valid CAN frame. */
78static inline int can_dropped_invalid_skb(struct net_device *dev,
79 struct sk_buff *skb)
80{
Oliver Hartkopp1e0625f2012-06-13 20:48:21 +020081 const struct canfd_frame *cfd = (struct canfd_frame *)skb->data;
Oliver Hartkopp3ccd4c62010-01-12 02:00:46 -080082
Oliver Hartkopp1e0625f2012-06-13 20:48:21 +020083 if (skb->protocol == htons(ETH_P_CAN)) {
84 if (unlikely(skb->len != CAN_MTU ||
85 cfd->len > CAN_MAX_DLEN))
86 goto inval_skb;
87 } else if (skb->protocol == htons(ETH_P_CANFD)) {
88 if (unlikely(skb->len != CANFD_MTU ||
89 cfd->len > CANFD_MAX_DLEN))
90 goto inval_skb;
91 } else
92 goto inval_skb;
Oliver Hartkopp3ccd4c62010-01-12 02:00:46 -080093
94 return 0;
Oliver Hartkopp1e0625f2012-06-13 20:48:21 +020095
96inval_skb:
97 kfree_skb(skb);
98 dev->stats.tx_dropped++;
99 return 1;
Oliver Hartkopp3ccd4c62010-01-12 02:00:46 -0800100}
101
Oliver Hartkopp1e0625f2012-06-13 20:48:21 +0200102/* get data length from can_dlc with sanitized can_dlc */
103u8 can_dlc2len(u8 can_dlc);
104
105/* map the sanitized data length to an appropriate data length code */
106u8 can_len2dlc(u8 len);
107
Wolfgang Grandeggera6e4bc52009-10-08 22:17:11 +0000108struct net_device *alloc_candev(int sizeof_priv, unsigned int echo_skb_max);
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +0000109void free_candev(struct net_device *dev);
110
Kurt Van Dijckbf03a532012-12-18 18:50:56 +0100111/* a candev safe wrapper around netdev_priv */
112struct can_priv *safe_candev_priv(struct net_device *dev);
113
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +0000114int open_candev(struct net_device *dev);
115void close_candev(struct net_device *dev);
Oliver Hartkoppbc05a892014-02-28 16:36:24 +0100116int can_change_mtu(struct net_device *dev, int new_mtu);
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +0000117
118int register_candev(struct net_device *dev);
119void unregister_candev(struct net_device *dev);
120
121int can_restart_now(struct net_device *dev);
122void can_bus_off(struct net_device *dev);
123
Wolfgang Grandeggera6e4bc52009-10-08 22:17:11 +0000124void can_put_echo_skb(struct sk_buff *skb, struct net_device *dev,
125 unsigned int idx);
Marc Kleine-Buddecf5046b2011-10-10 23:43:53 +0200126unsigned int can_get_echo_skb(struct net_device *dev, unsigned int idx);
Wolfgang Grandeggera6e4bc52009-10-08 22:17:11 +0000127void can_free_echo_skb(struct net_device *dev, unsigned int idx);
Wolfgang Grandegger39549ee2009-05-15 23:39:29 +0000128
Wolfgang Grandegger7b6856a2009-10-20 00:08:01 -0700129struct sk_buff *alloc_can_skb(struct net_device *dev, struct can_frame **cf);
Stephane Grosjeancb2518c2014-01-15 09:50:13 +0100130struct sk_buff *alloc_canfd_skb(struct net_device *dev,
131 struct canfd_frame **cfd);
Wolfgang Grandegger7b6856a2009-10-20 00:08:01 -0700132struct sk_buff *alloc_can_err_skb(struct net_device *dev,
133 struct can_frame **cf);
134
Oliver Hartkopp42193e32014-05-15 20:31:56 +0200135#endif /* !_CAN_DEV_H */