c5b738def81b614d2a33a4333a88ddc172146121
[firefly-linux-kernel-4.4.55.git] / drivers / staging / batman-adv / types.h
1 /*
2  * Copyright (C) 2007-2010 B.A.T.M.A.N. contributors:
3  *
4  * Marek Lindner, Simon Wunderlich
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of version 2 of the GNU General Public
8  * License as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18  * 02110-1301, USA
19  *
20  */
21
22
23
24 #ifndef _NET_BATMAN_ADV_TYPES_H_
25 #define _NET_BATMAN_ADV_TYPES_H_
26
27 #include "packet.h"
28 #include "bitarray.h"
29
30 #define BAT_HEADER_LEN (sizeof(struct ethhdr) + \
31         ((sizeof(struct unicast_packet) > sizeof(struct bcast_packet) ? \
32          sizeof(struct unicast_packet) : \
33          sizeof(struct bcast_packet))))
34
35
36 struct batman_if {
37         struct list_head list;
38         int16_t if_num;
39         char *dev;
40         char if_status;
41         char addr_str[ETH_STR_LEN];
42         struct net_device *net_dev;
43         atomic_t seqno;
44         atomic_t frag_seqno;
45         unsigned char *packet_buff;
46         int packet_len;
47         struct kobject *hardif_obj;
48         struct rcu_head rcu;
49         struct packet_type batman_adv_ptype;
50         struct net_device *soft_iface;
51 };
52
53 /**
54   *     orig_node - structure for orig_list maintaining nodes of mesh
55   *     @primary_addr: hosts primary interface address
56   *     @last_valid: when last packet from this node was received
57   *     @bcast_seqno_reset: time when the broadcast seqno window was reset
58   *     @batman_seqno_reset: time when the batman seqno window was reset
59   *     @flags: for now only VIS_SERVER flag
60   *     @last_real_seqno: last and best known squence number
61   *     @last_ttl: ttl of last received packet
62   *     @last_bcast_seqno: last broadcast sequence number received by this host
63   *
64   *     @candidates: how many candidates are available
65   *     @selected: next bonding candidate
66  */
67 struct orig_node {
68         uint8_t orig[ETH_ALEN];
69         uint8_t primary_addr[ETH_ALEN];
70         struct neigh_node *router;
71         TYPE_OF_WORD *bcast_own;
72         uint8_t *bcast_own_sum;
73         uint8_t tq_own;
74         int tq_asym_penalty;
75         unsigned long last_valid;
76         unsigned long bcast_seqno_reset;
77         unsigned long batman_seqno_reset;
78         uint8_t  flags;
79         unsigned char *hna_buff;
80         int16_t hna_buff_len;
81         uint32_t last_real_seqno;
82         uint8_t last_ttl;
83         TYPE_OF_WORD bcast_bits[NUM_WORDS];
84         uint32_t last_bcast_seqno;
85         struct list_head neigh_list;
86         struct list_head frag_list;
87         unsigned long last_frag_packet;
88         struct {
89                 uint8_t candidates;
90                 struct neigh_node *selected;
91         } bond;
92 };
93
94 /**
95   *     neigh_node
96   *     @last_valid: when last packet via this neighbor was received
97  */
98 struct neigh_node {
99         struct list_head list;
100         uint8_t addr[ETH_ALEN];
101         uint8_t real_packet_count;
102         uint8_t tq_recv[TQ_GLOBAL_WINDOW_SIZE];
103         uint8_t tq_index;
104         uint8_t tq_avg;
105         uint8_t last_ttl;
106         struct neigh_node *next_bond_candidate;
107         unsigned long last_valid;
108         TYPE_OF_WORD real_bits[NUM_WORDS];
109         struct orig_node *orig_node;
110         struct batman_if *if_incoming;
111 };
112
113 struct bat_priv {
114         struct net_device_stats stats;
115         atomic_t aggregation_enabled;
116         atomic_t bonding_enabled;
117         atomic_t frag_enabled;
118         atomic_t vis_mode;
119         atomic_t orig_interval;
120         atomic_t log_level;
121         atomic_t bcast_queue_left;
122         atomic_t batman_queue_left;
123         char num_ifaces;
124         struct debug_log *debug_log;
125         struct batman_if *primary_if;
126         struct kobject *mesh_obj;
127         struct dentry *debug_dir;
128 };
129
130 struct socket_client {
131         struct list_head queue_list;
132         unsigned int queue_len;
133         unsigned char index;
134         spinlock_t lock;
135         wait_queue_head_t queue_wait;
136         struct bat_priv *bat_priv;
137 };
138
139 struct socket_packet {
140         struct list_head list;
141         size_t icmp_len;
142         struct icmp_packet_rr icmp_packet;
143 };
144
145 struct hna_local_entry {
146         uint8_t addr[ETH_ALEN];
147         unsigned long last_seen;
148         char never_purge;
149 };
150
151 struct hna_global_entry {
152         uint8_t addr[ETH_ALEN];
153         struct orig_node *orig_node;
154 };
155
156 /**
157   *     forw_packet - structure for forw_list maintaining packets to be
158   *                   send/forwarded
159  */
160 struct forw_packet {
161         struct hlist_node list;
162         unsigned long send_time;
163         uint8_t own;
164         struct sk_buff *skb;
165         uint16_t packet_len;
166         uint32_t direct_link_flags;
167         uint8_t num_packets;
168         struct delayed_work delayed_work;
169         struct batman_if *if_incoming;
170 };
171
172 /* While scanning for vis-entries of a particular vis-originator
173  * this list collects its interfaces to create a subgraph/cluster
174  * out of them later
175  */
176 struct if_list_entry {
177         uint8_t addr[ETH_ALEN];
178         bool primary;
179         struct hlist_node list;
180 };
181
182 struct debug_log {
183         char log_buff[LOG_BUF_LEN];
184         unsigned long log_start;
185         unsigned long log_end;
186         spinlock_t lock;
187         wait_queue_head_t queue_wait;
188 };
189
190 struct frag_packet_list_entry {
191         struct list_head list;
192         uint16_t seqno;
193         struct sk_buff *skb;
194 };
195
196 #endif /* _NET_BATMAN_ADV_TYPES_H_ */