Staging: batman-adv: layer2 unicast packet fragmentation
[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
50 };
51
52 /**
53   *     orig_node - structure for orig_list maintaining nodes of mesh
54   *     @primary_addr: hosts primary interface address
55   *     @last_valid: when last packet from this node was received
56   *     @bcast_seqno_reset: time when the broadcast seqno window was reset
57   *     @batman_seqno_reset: time when the batman seqno window was reset
58   *     @flags: for now only VIS_SERVER flag
59   *     @last_real_seqno: last and best known squence number
60   *     @last_ttl: ttl of last received packet
61   *     @last_bcast_seqno: last broadcast sequence number received by this host
62   *
63   *     @candidates: how many candidates are available
64   *     @selected: next bonding candidate
65  */
66 struct orig_node {
67         uint8_t orig[ETH_ALEN];
68         uint8_t primary_addr[ETH_ALEN];
69         struct neigh_node *router;
70         TYPE_OF_WORD *bcast_own;
71         uint8_t *bcast_own_sum;
72         uint8_t tq_own;
73         int tq_asym_penalty;
74         unsigned long last_valid;
75         unsigned long bcast_seqno_reset;
76         unsigned long batman_seqno_reset;
77         uint8_t  flags;
78         unsigned char *hna_buff;
79         int16_t hna_buff_len;
80         uint32_t last_real_seqno;
81         uint8_t last_ttl;
82         TYPE_OF_WORD bcast_bits[NUM_WORDS];
83         uint32_t last_bcast_seqno;
84         struct list_head neigh_list;
85         struct list_head frag_list;
86         unsigned long last_frag_packet;
87         struct {
88                 uint8_t candidates;
89                 struct neigh_node *selected;
90         } bond;
91 };
92
93 /**
94   *     neigh_node
95   *     @last_valid: when last packet via this neighbor was received
96  */
97 struct neigh_node {
98         struct list_head list;
99         uint8_t addr[ETH_ALEN];
100         uint8_t real_packet_count;
101         uint8_t tq_recv[TQ_GLOBAL_WINDOW_SIZE];
102         uint8_t tq_index;
103         uint8_t tq_avg;
104         uint8_t last_ttl;
105         struct neigh_node *next_bond_candidate;
106         unsigned long last_valid;
107         TYPE_OF_WORD real_bits[NUM_WORDS];
108         struct orig_node *orig_node;
109         struct batman_if *if_incoming;
110 };
111
112 struct bat_priv {
113         struct net_device_stats stats;
114         atomic_t aggregation_enabled;
115         atomic_t bonding_enabled;
116         atomic_t frag_enabled;
117         atomic_t vis_mode;
118         atomic_t orig_interval;
119         atomic_t log_level;
120         atomic_t bcast_queue_left;
121         atomic_t batman_queue_left;
122         char num_ifaces;
123         struct debug_log *debug_log;
124         struct batman_if *primary_if;
125         struct kobject *mesh_obj;
126         struct dentry *debug_dir;
127 };
128
129 struct socket_client {
130         struct list_head queue_list;
131         unsigned int queue_len;
132         unsigned char index;
133         spinlock_t lock;
134         wait_queue_head_t queue_wait;
135         struct bat_priv *bat_priv;
136 };
137
138 struct socket_packet {
139         struct list_head list;
140         size_t icmp_len;
141         struct icmp_packet_rr icmp_packet;
142 };
143
144 struct hna_local_entry {
145         uint8_t addr[ETH_ALEN];
146         unsigned long last_seen;
147         char never_purge;
148 };
149
150 struct hna_global_entry {
151         uint8_t addr[ETH_ALEN];
152         struct orig_node *orig_node;
153 };
154
155 /**
156   *     forw_packet - structure for forw_list maintaining packets to be
157   *                   send/forwarded
158  */
159 struct forw_packet {
160         struct hlist_node list;
161         unsigned long send_time;
162         uint8_t own;
163         struct sk_buff *skb;
164         unsigned char *packet_buff;
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_ */