Linux 3.2.102
[pandora-kernel.git] / net / can / af_can.h
1 /*
2  * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of Volkswagen nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * Alternatively, provided that this notice is retained in full, this
18  * software may be distributed under the terms of the GNU General
19  * Public License ("GPL") version 2, in which case the provisions of the
20  * GPL apply INSTEAD OF those given above.
21  *
22  * The provided data structures and external interfaces from this code
23  * are not restricted to be used by modules with a GPL compatible license.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
36  * DAMAGE.
37  *
38  */
39
40 #ifndef AF_CAN_H
41 #define AF_CAN_H
42
43 #include <linux/skbuff.h>
44 #include <linux/netdevice.h>
45 #include <linux/list.h>
46 #include <linux/rcupdate.h>
47 #include <linux/can.h>
48
49 /* af_can rx dispatcher structures */
50
51 struct receiver {
52         struct hlist_node list;
53         canid_t can_id;
54         canid_t mask;
55         unsigned long matches;
56         void (*func)(struct sk_buff *, void *);
57         void *data;
58         char *ident;
59         struct sock *sk;
60         struct rcu_head rcu;
61 };
62
63 enum { RX_ERR, RX_ALL, RX_FIL, RX_INV, RX_EFF, RX_MAX };
64
65 /* per device receive filters linked at dev->ml_priv */
66 struct dev_rcv_lists {
67         struct hlist_head rx[RX_MAX];
68         struct hlist_head rx_sff[0x800];
69         int remove_on_zero_entries;
70         int entries;
71 };
72
73 /* statistic structures */
74
75 /* can be reset e.g. by can_init_stats() */
76 struct s_stats {
77         unsigned long jiffies_init;
78
79         unsigned long rx_frames;
80         unsigned long tx_frames;
81         unsigned long matches;
82
83         unsigned long total_rx_rate;
84         unsigned long total_tx_rate;
85         unsigned long total_rx_match_ratio;
86
87         unsigned long current_rx_rate;
88         unsigned long current_tx_rate;
89         unsigned long current_rx_match_ratio;
90
91         unsigned long max_rx_rate;
92         unsigned long max_tx_rate;
93         unsigned long max_rx_match_ratio;
94
95         unsigned long rx_frames_delta;
96         unsigned long tx_frames_delta;
97         unsigned long matches_delta;
98 };
99
100 /* persistent statistics */
101 struct s_pstats {
102         unsigned long stats_reset;
103         unsigned long user_reset;
104         unsigned long rcv_entries;
105         unsigned long rcv_entries_max;
106 };
107
108 /* function prototypes for the CAN networklayer procfs (proc.c) */
109 extern void can_init_proc(void);
110 extern void can_remove_proc(void);
111 extern void can_stat_update(unsigned long data);
112
113 /* structures and variables from af_can.c needed in proc.c for reading */
114 extern struct timer_list can_stattimer;    /* timer for statistics update */
115 extern struct s_stats    can_stats;        /* packet statistics */
116 extern struct s_pstats   can_pstats;       /* receive list statistics */
117 extern struct hlist_head can_rx_dev_list;  /* rx dispatcher structures */
118
119 #endif /* AF_CAN_H */