Instead of converting between 802.11 frequencies and channels umpteen
[obnox/wireshark/wip.git] / epan / dissectors / packet-wlancap.c
1 /*
2  *  packet-wlancap.c
3  *      Decode packets with a AVS-WLAN header
4  *
5  *  AVS linux-wlan-based products use a new sniff header to replace the
6  *  old prism2-specific one dissected in packet-prism2.c.  This one has
7  *  additional fields, is designed to be non-hardware-specific, and more
8  *  importantly, version and length fields so it can be extended later
9  *  without breaking anything.
10  *
11  *  See
12  *
13  *      https://mail.shaftnet.org/chora/browse.php?rt=wlanng&f=trunk%2Fdoc%2Fcapturefrm.txt
14  *
15  * By Solomon Peachy
16  *
17  * $Id$
18  *
19  * Wireshark - Network traffic analyzer
20  * By Gerald Combs <gerald@wireshark.org>
21  * Copyright 1998 Gerald Combs
22  *
23  * Copied from README.developer
24  *
25  * This program is free software; you can redistribute it and/or
26  * modify it under the terms of the GNU General Public License
27  * as published by the Free Software Foundation; either version 2
28  * of the License, or (at your option) any later version.
29  *
30  * This program is distributed in the hope that it will be useful,
31  * but WITHOUT ANY WARRANTY; without even the implied warranty of
32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
33  * GNU General Public License for more details.
34  *
35  * You should have received a copy of the GNU General Public License
36  * along with this program; if not, write to the Free Software
37  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
38  */
39
40 #ifdef HAVE_CONFIG_H
41 # include "config.h"
42 #endif
43
44 #include <glib.h>
45 #include <string.h>
46
47 #include <epan/packet.h>
48 #include "packet-ieee80211.h"
49 #include "packet-wlancap.h"
50
51 #define SHORT_STR 256
52
53 /* protocol */
54 static int proto_wlancap = -1;
55
56 /* header attached during wlan monitor mode */
57 struct wlan_header_v1 {
58   guint32 version;
59   guint32 length;
60   guint64 mactime;
61   guint64 hosttime;
62   guint32 phytype;
63   guint32 channel;
64   guint32 datarate;
65   guint32 antenna;
66   guint32 priority;
67   guint32 ssi_type;
68   gint32 ssi_signal;
69   gint32 ssi_noise;
70   gint32 preamble;
71   gint32 encoding;
72 };
73
74 /* V2 of the header */
75 struct wlan_header_v2 {
76   struct wlan_header_v1 v1_hdr;
77   guint32 sequence;
78   guint32 drops;
79   guint8 sniffer_addr[6];
80   guint8 pad[2];
81 };
82
83 static int hf_wlan_magic = -1;
84 static int hf_wlan_version = -1;
85 static int hf_wlan_length = -1;
86 static int hf_wlan_mactime = -1;
87 static int hf_wlan_hosttime = -1;
88 static int hf_wlan_phytype = -1;
89 static int hf_wlan_channel = -1;
90 static int hf_wlan_datarate = -1;
91 static int hf_wlan_antenna = -1;
92 static int hf_wlan_priority = -1;
93 static int hf_wlan_ssi_type = -1;
94 static int hf_wlan_ssi_signal = -1;
95 static int hf_wlan_ssi_noise = -1;
96 static int hf_wlan_preamble = -1;
97 static int hf_wlan_encoding = -1;
98 static int hf_wlan_sequence = -1;
99 static int hf_wlan_drops = -1;
100 static int hf_wlan_sniffer_addr = -1;
101 static int hf_wlan_padding = -1;
102
103 static gint ett_wlan = -1;
104
105 static dissector_handle_t ieee80211_handle;
106
107 static void
108 dissect_wlancap(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
109
110 void
111 capture_wlancap(const guchar *pd, int offset, int len, packet_counts *ld)
112 {
113     /* XXX eventually add in a version test. */
114     if(!BYTES_ARE_IN_FRAME(offset, len, (int)sizeof(struct wlan_header_v1))) {
115         ld->other ++;
116         return;
117     }
118     offset += sizeof(struct wlan_header_v1);
119
120     /* 802.11 header follows */
121     capture_ieee80211(pd, offset, len, ld);
122 }
123
124 void
125 proto_register_wlancap(void)
126 {
127
128   static const value_string phy_type[] = {
129     { 0, "Unknown" },
130     { 1, "FHSS 802.11 '97" },
131     { 2, "DSSS 802.11 '97" },
132     { 3, "IR Baseband" },
133     { 4, "DSSS 802.11b" },
134     { 5, "PBCC 802.11b" },
135     { 6, "OFDM 802.11g" },
136     { 7, "PBCC 802.11g" },
137     { 8, "OFDM 802.11a" },
138     { 0, NULL },
139   };
140
141   static const value_string encoding_type[] = {
142     { 0, "Unknown" },
143     { 1, "CCK" },
144     { 2, "PBCC" },
145     { 3, "OFDM" },
146     { 4, "DSS-OFDM" },
147     { 5, "BPSK" },
148     { 6, "QPSK" },
149     { 7, "16QAM" },
150     { 8, "64QAM" },
151     { 0, NULL },
152   };
153
154   static const value_string ssi_type[] = {
155     { 0, "None" },
156     { 1, "Normalized RSSI" },
157     { 2, "dBm" },
158     { 3, "Raw RSSI" },
159     { 0, NULL },
160   };
161
162   static const value_string preamble_type[] = {
163     { 0, "Unknown" },
164     { 1, "Short" },
165     { 2, "Long" },
166     { 0, NULL },
167   };
168
169   static hf_register_info hf[] = {
170     { &hf_wlan_magic, { "Header magic", "wlancap.magic", FT_UINT32,
171                           BASE_HEX, NULL, 0xFFFFFFF0, "", HFILL } },
172     { &hf_wlan_version, { "Header revision", "wlancap.version", FT_UINT32,
173                           BASE_DEC, NULL, 0xF, "", HFILL } },
174     { &hf_wlan_length, { "Header length", "wlancap.length", FT_UINT32,
175                          BASE_DEC, NULL, 0x0, "", HFILL } },
176     { &hf_wlan_mactime, { "MAC timestamp", "wlancap.mactime", FT_UINT64,
177                           BASE_DEC, NULL, 0x0, "", HFILL } },
178     { &hf_wlan_hosttime, { "Host timestamp", "wlancap.hosttime", FT_UINT64,
179                            BASE_DEC, NULL, 0x0, "", HFILL } },
180     { &hf_wlan_phytype, { "PHY type", "wlancap.phytype", FT_UINT32, BASE_DEC,
181                           VALS(phy_type), 0x0, "", HFILL } },
182     { &hf_wlan_channel, { "Channel", "wlancap.channel", FT_UINT32, BASE_DEC,
183                           NULL, 0x0, "", HFILL } },
184     { &hf_wlan_datarate, { "Data rate", "wlancap.datarate", FT_UINT32,
185                            BASE_DEC, NULL, 0x0, "", HFILL } },
186     { &hf_wlan_antenna, { "Antenna", "wlancap.antenna", FT_UINT32, BASE_DEC,
187                           NULL, 0x0, "", HFILL } },
188     { &hf_wlan_priority, { "Priority", "wlancap.priority", FT_UINT32, BASE_DEC,
189                            NULL, 0x0, "", HFILL } },
190     { &hf_wlan_ssi_type, { "SSI Type", "wlancap.ssi_type", FT_UINT32, BASE_DEC,
191                            VALS(ssi_type), 0x0, "", HFILL } },
192     { &hf_wlan_ssi_signal, { "SSI Signal", "wlancap.ssi_signal", FT_INT32,
193                              BASE_DEC, NULL, 0x0, "", HFILL } },
194     { &hf_wlan_ssi_noise, { "SSI Noise", "wlancap.ssi_noise", FT_INT32,
195                             BASE_DEC, NULL, 0x0, "", HFILL } },
196     { &hf_wlan_preamble, { "Preamble", "wlancap.preamble", FT_UINT32,
197                            BASE_DEC, VALS(preamble_type), 0x0, "", HFILL } },
198     { &hf_wlan_encoding, { "Encoding Type", "wlancap.encoding", FT_UINT32,
199                            BASE_DEC, VALS(encoding_type), 0x0, "", HFILL } },
200     { &hf_wlan_sequence, { "Receive sequence", "wlancap.sequence", FT_UINT32,
201                            BASE_DEC, NULL, 0x0, "", HFILL } },
202     { &hf_wlan_drops, { "Known Dropped Frames", "wlancap.drops", FT_UINT32,
203                            BASE_DEC, NULL, 0x0, "", HFILL } },
204     { &hf_wlan_sniffer_addr, { "Sniffer Address", "wlancap.sniffer_addr", FT_ETHER,
205                                BASE_NONE, NULL, 0x0, "Sniffer Hardware Address", HFILL } },
206     { &hf_wlan_padding, { "Padding", "wlancap.padding", FT_BYTES,
207                           BASE_NONE, NULL, 0x0, "", HFILL } },
208   };
209   static gint *ett[] = {
210     &ett_wlan
211   };
212
213   proto_wlancap = proto_register_protocol("AVS WLAN Capture header", "AVS WLANCAP", "wlancap");
214   proto_register_field_array(proto_wlancap, hf, array_length(hf));
215   proto_register_subtree_array(ett, array_length(ett));
216   register_dissector("wlancap", dissect_wlancap, proto_wlancap);
217
218 }
219
220 static void
221 dissect_wlancap(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
222 {
223     proto_tree *wlan_tree;
224     proto_item *ti;
225     tvbuff_t *next_tvb;
226     int offset;
227     guint32 version;
228     guint32 length;
229     guint32 datarate;
230
231     if(check_col(pinfo->cinfo, COL_PROTOCOL))
232         col_set_str(pinfo->cinfo, COL_PROTOCOL, "WLAN");
233     if(check_col(pinfo->cinfo, COL_INFO))
234         col_clear(pinfo->cinfo, COL_INFO);
235     offset = 0;
236
237     version = tvb_get_ntohl(tvb, offset) - WLANCAP_MAGIC_COOKIE_BASE;
238     length = tvb_get_ntohl(tvb, offset+4);
239
240     if(check_col(pinfo->cinfo, COL_INFO))
241         col_add_fstr(pinfo->cinfo, COL_INFO, "AVS WLAN Capture v%x, Length %d",version, length);
242
243     if (check_col(pinfo->cinfo, COL_FREQ_CHAN)) {
244       col_add_fstr(pinfo->cinfo, COL_FREQ_CHAN, "%u",
245                    tvb_get_ntohl(tvb, offset + 28));
246     }
247     if (check_col(pinfo->cinfo, COL_TX_RATE)) {
248       guint32 txrate = tvb_get_ntohl(tvb, offset + 32);
249       col_add_fstr(pinfo->cinfo, COL_TX_RATE, "%u.%u",
250                    txrate / 10, txrate % 10);
251     }
252     if (check_col(pinfo->cinfo, COL_RSSI)) {
253       /* XXX cook ssi_signal (Based on type; ie format) */
254       col_add_fstr(pinfo->cinfo, COL_RSSI, "%u",
255                    tvb_get_ntohl(tvb, offset + 48));
256     }
257
258     /* Dissect the packet */
259     if (tree) {
260       ti = proto_tree_add_protocol_format(tree, proto_wlancap,
261             tvb, 0, length, "AVS WLAN Monitoring Header");
262       wlan_tree = proto_item_add_subtree(ti, ett_wlan);
263       proto_tree_add_item(wlan_tree, hf_wlan_magic, tvb, offset, 4, FALSE);
264       proto_tree_add_item(wlan_tree, hf_wlan_version, tvb, offset, 4, FALSE);
265       offset+=4;
266       proto_tree_add_item(wlan_tree, hf_wlan_length, tvb, offset, 4, FALSE);
267       offset+=4;
268       proto_tree_add_item(wlan_tree, hf_wlan_mactime, tvb, offset, 8, FALSE);
269       offset+=8;
270       proto_tree_add_item(wlan_tree, hf_wlan_hosttime, tvb, offset, 8, FALSE);
271       offset+=8;
272       proto_tree_add_item(wlan_tree, hf_wlan_phytype, tvb, offset, 4, FALSE);
273       offset+=4;
274       /* XXX cook channel (fh uses different numbers) */
275       proto_tree_add_item(wlan_tree, hf_wlan_channel, tvb, offset, 4, FALSE);
276       offset+=4;
277       /* XXX - all other 802.11 pseudo-headers use 500Kb/s, not 100Kb/s,
278          as the units. */
279       datarate = tvb_get_ntohl(tvb, offset);
280       proto_tree_add_uint_format(wlan_tree, hf_wlan_datarate, tvb, offset,
281                                  4, datarate * 100,
282                                  "Data Rate: %u Kb/s", datarate * 100);
283       offset+=4;
284       proto_tree_add_item(wlan_tree, hf_wlan_antenna, tvb, offset, 4, FALSE);
285       offset+=4;
286       proto_tree_add_item(wlan_tree, hf_wlan_priority, tvb, offset, 4, FALSE);
287       offset+=4;
288       proto_tree_add_item(wlan_tree, hf_wlan_ssi_type, tvb, offset, 4, FALSE);
289       offset+=4;
290       /* XXX cook ssi_signal (Based on type; ie format) */
291       proto_tree_add_item(wlan_tree, hf_wlan_ssi_signal, tvb, offset, 4, FALSE);
292       offset+=4;
293       /* XXX cook ssi_noise (Based on type; ie format) */
294       proto_tree_add_item(wlan_tree, hf_wlan_ssi_noise, tvb, offset, 4, FALSE);
295       offset+=4;
296       proto_tree_add_item(wlan_tree, hf_wlan_preamble, tvb, offset, 4, FALSE);
297       offset+=4;
298       proto_tree_add_item(wlan_tree, hf_wlan_encoding, tvb, offset, 4, FALSE);
299       offset+=4;
300       if (version > 1) {
301               proto_tree_add_item(wlan_tree, hf_wlan_sequence, tvb, offset,
302                         4, FALSE);
303               offset+=4;
304               proto_tree_add_item(wlan_tree, hf_wlan_drops, tvb, offset,
305                         4, FALSE);
306               offset+=4;
307               proto_tree_add_item(wlan_tree, hf_wlan_sniffer_addr, tvb, offset,
308                         6, FALSE);
309               offset+=6;
310               proto_tree_add_item(wlan_tree, hf_wlan_padding, tvb, offset,
311                         2, FALSE);
312               offset+=2;
313       }
314     }
315
316     offset = length;
317
318     /* dissect the 802.11 header next */
319     next_tvb = tvb_new_subset(tvb, offset, -1, -1);
320     call_dissector(ieee80211_handle, next_tvb, pinfo, tree);
321 }
322
323 void
324 proto_reg_handoff_wlancap(void)
325 {
326     dissector_handle_t wlancap_handle;
327
328     /* handle for 802.11 dissector */
329     ieee80211_handle = find_dissector("wlan");
330
331     wlancap_handle = create_dissector_handle(dissect_wlancap, proto_wlancap);
332
333     dissector_add("wtap_encap", WTAP_ENCAP_IEEE_802_11_WLAN_AVS, wlancap_handle);
334 }