aboutsummaryrefslogtreecommitdiffstats
path: root/epan/dissectors/packet-loratap.c
blob: 782c63bdc2de6308397a27e7aa767b480a788da3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
/* packet-loratap.c
 * Dissector routines for the LoRaTap encapsulation
 * By Erik de Jong <erikdejong@gmail.com>
 * Copyright 2017 Erik de Jong
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include "config.h"
#include <wiretap/wtap.h>
#include <epan/packet.h>
#include <epan/capture_dissectors.h>

void proto_reg_handoff_loratap(void);
void proto_register_loratap(void);

static dissector_handle_t loratap_handle;

static dissector_table_t loratap_dissector_table;

static int proto_loratap = -1;
static int hf_loratap_header_version_type = -1;
static int hf_loratap_header_length_type = -1;
static int hf_loratap_header_padding = -1;
static int hf_loratap_header_channel_type = -1;
static int hf_loratap_header_channel_frequency_type = -1;
static int hf_loratap_header_channel_bandwidth_type = -1;
static int hf_loratap_header_channel_sf_type = -1;
static int hf_loratap_header_rssi_type = -1;
static int hf_loratap_header_rssi_packet_type = -1;
static int hf_loratap_header_rssi_max_type = -1;
static int hf_loratap_header_rssi_current_type = -1;
static int hf_loratap_header_rssi_snr_type = -1;
static int hf_loratap_header_syncword_type = -1;

static gint ett_loratap = -1;

static const value_string channel_bandwidth[] = {
	{ 1, "125 KHz" },
	{ 2, "250 KHz" },
	{ 4, "500 KHz" },
	{ 0, NULL}
};

static const value_string syncwords[] = {
	{ 0x34, "LoRaWAN" },
	{ 0, NULL}
};

static void
rssi_base_custom(gchar *buffer, guint32 value) {
	g_snprintf(buffer, ITEM_LABEL_LENGTH, "%.0f dBm", -139 + (float)value);
}

static void
snr_base_custom(gchar *buffer, guint32 value) {
	if( value & 0x80 ) {
		value = ( ( ~value + 1 ) & 0xFF ) >> 2;
	} else {
		value = ( value & 0xFF ) >> 2;
	}
	g_snprintf(buffer, ITEM_LABEL_LENGTH, "%d dB", value);
}

static int
dissect_loratap(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree _U_, void *data _U_)
{
	proto_item *ti, *channel_item, *rssi_item;
	proto_tree *loratap_tree, *channel_tree, *rssi_tree;
	gint32 current_offset = 0;
	guint16 length;
	guint32 syncword;
	tvbuff_t *next_tvb;

	col_set_str(pinfo->cinfo, COL_PROTOCOL, "LoRaTap");
	col_clear(pinfo->cinfo,COL_INFO);
	length = tvb_get_guint16(tvb, 2, ENC_BIG_ENDIAN);
	ti = proto_tree_add_item(tree, proto_loratap, tvb, 0, length, ENC_NA);
	loratap_tree = proto_item_add_subtree(ti, ett_loratap);
	proto_tree_add_item(loratap_tree, hf_loratap_header_version_type, tvb, current_offset, 1, ENC_NA);
	current_offset++;
	proto_tree_add_item(loratap_tree, hf_loratap_header_padding, tvb, current_offset, 1, ENC_NA);
	current_offset++;
	proto_tree_add_item(loratap_tree, hf_loratap_header_length_type, tvb, current_offset, 2, ENC_NA);
	current_offset += 2;
	channel_item = proto_tree_add_item(loratap_tree, hf_loratap_header_channel_type, tvb, current_offset, 6, ENC_NA);
	channel_tree = proto_item_add_subtree(channel_item, ett_loratap);
	proto_tree_add_item(channel_tree, hf_loratap_header_channel_frequency_type, tvb, current_offset, 4, ENC_NA);
	current_offset += 4;
	proto_tree_add_item(channel_tree, hf_loratap_header_channel_bandwidth_type, tvb, current_offset, 1, ENC_NA);
	current_offset++;
	proto_tree_add_item(channel_tree, hf_loratap_header_channel_sf_type, tvb, current_offset, 1, ENC_NA);
	current_offset++;
	rssi_item = proto_tree_add_item(loratap_tree, hf_loratap_header_rssi_type, tvb, current_offset, 4, ENC_NA);
	rssi_tree = proto_item_add_subtree(rssi_item, ett_loratap);
	proto_tree_add_item(rssi_tree, hf_loratap_header_rssi_packet_type, tvb, current_offset, 1, ENC_NA);
	current_offset++;
	proto_tree_add_item(rssi_tree, hf_loratap_header_rssi_max_type, tvb, current_offset, 1, ENC_NA);
	current_offset++;
	proto_tree_add_item(rssi_tree, hf_loratap_header_rssi_current_type, tvb, current_offset, 1, ENC_NA);
	current_offset++;
	proto_tree_add_item(rssi_tree, hf_loratap_header_rssi_snr_type, tvb, current_offset, 1, ENC_NA);
	current_offset++;
	proto_tree_add_item_ret_uint(loratap_tree, hf_loratap_header_syncword_type, tvb, current_offset, 1, ENC_NA, &syncword);
	current_offset++;

	next_tvb = tvb_new_subset_length_caplen(tvb, current_offset, tvb_captured_length_remaining(tvb, current_offset), tvb_reported_length_remaining(tvb, current_offset));

	if (!dissector_try_uint_new(loratap_dissector_table, syncword, next_tvb, pinfo, tree, TRUE, NULL)) {
		call_data_dissector(next_tvb, pinfo, tree);
	}

	return tvb_captured_length(tvb);
}

void
proto_reg_handoff_loratap(void)
{
	dissector_add_uint("wtap_encap", WTAP_ENCAP_LORATAP, loratap_handle);
}

void
proto_register_loratap(void)
{
	static hf_register_info hf[] = {
	{ &hf_loratap_header_version_type,
		{ "Header Version", "loratap.version",
		FT_UINT8, BASE_DEC,
		NULL, 0x0,
		NULL, HFILL }
	},
	{ &hf_loratap_header_length_type,
		{ "Header Length", "loratap.header_length",
		FT_UINT16, BASE_DEC,
		NULL, 0x0,
		NULL, HFILL }
	},
	{ &hf_loratap_header_padding,
		{ "Padding", "loratap.padding",
		FT_BYTES, BASE_NONE,
		NULL, 0x0,
		NULL, HFILL }
	},
	{ &hf_loratap_header_channel_type,
		{ "Channel", "loratap.channel",
		FT_NONE, BASE_NONE,
		NULL, 0x0,
		NULL, HFILL }
	},
	{ &hf_loratap_header_channel_frequency_type,
		{ "Frequency", "loratap.channel.frequency",
		FT_UINT32, BASE_DEC|BASE_UNIT_STRING,
		&units_hz, 0x0,
		NULL, HFILL }
	},
	{ &hf_loratap_header_channel_bandwidth_type,
		{ "Bandwidth", "loratap.channel.bandwidth",
		FT_UINT8, BASE_DEC,
		VALS(channel_bandwidth), 0x0,
		NULL, HFILL }
	},
	{ &hf_loratap_header_channel_sf_type,
		{ "Spreading Factor", "loratap.channel.sf",
		FT_UINT8, BASE_DEC,
		NULL, 0x0,
		NULL, HFILL }
	},
	{ &hf_loratap_header_rssi_type,
		{ "RSSI", "loratap.rssi",
		FT_NONE, BASE_NONE,
		NULL, 0x0,
		NULL, HFILL }
	},
	{ &hf_loratap_header_rssi_packet_type,
		{ "Packet", "loratap.rssi.packet",
		FT_UINT8, BASE_CUSTOM,
		CF_FUNC(rssi_base_custom), 0x0,
		NULL, HFILL }
	},
	{ &hf_loratap_header_rssi_max_type,
		{ "Max", "loratap.rssi.max",
		FT_UINT8, BASE_CUSTOM,
		CF_FUNC(rssi_base_custom), 0x0,
		NULL, HFILL }
	},
	{ &hf_loratap_header_rssi_current_type,
		{ "Current", "loratap.rssi.current",
		FT_UINT8, BASE_CUSTOM,
		CF_FUNC(rssi_base_custom), 0x0,
		NULL, HFILL }
	},
	{ &hf_loratap_header_rssi_snr_type,
		{ "SNR", "loratap.rssi.snr",
		FT_UINT8, BASE_CUSTOM,
		CF_FUNC(snr_base_custom), 0x0,
		NULL, HFILL }
	},
	{ &hf_loratap_header_syncword_type,
		{ "Sync Word", "loratap.syncword",
		FT_UINT8, BASE_HEX,
		VALS(syncwords), 0x0,
		NULL, HFILL }
	},
	};

	/* Setup protocol subtree array */
	static gint *ett[] = {
		&ett_loratap
	};

	proto_loratap = proto_register_protocol (
		"LoRaTap header",	/* name */
		"LoRaTap",		/* short name */
		"loratap"		/* abbrev */
	);

	loratap_handle = register_dissector("loratap", dissect_loratap, proto_loratap);
	proto_register_field_array(proto_loratap, hf, array_length(hf));
	proto_register_subtree_array(ett, array_length(ett));
	loratap_dissector_table = register_dissector_table("loratap.syncword", "LoRa Syncword", proto_loratap, FT_UINT8, BASE_HEX);
}

/*
 * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
 *
 * Local variables:
 * c-basic-offset: 8
 * tab-width: 8
 * indent-tabs-mode: t
 * End:
 *
 * vi: set shiftwidth=8 tabstop=8 noexpandtab:
 * :indentSize=8:tabSize=8:noTabs=false:
 */