Remove all $Id$ from top of file
[metze/wireshark/wip.git] / epan / dissectors / packet-dis-fields.h
1 /* packet-dis-fields.h
2  * Declarations for DIS field parsing.
3  * Copyright 2005, Scientific Research Corporation
4  * Initial implementation by Jeremy Ouellette <jouellet@scires.com>
5  *
6  * Wireshark - Network traffic analyzer
7  * By Gerald Combs <gerald@wireshark.org>
8  * Copyright 1998 Gerald Combs
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23  */
24
25 #ifndef __PACKET_DIS_FIELDPARSERS_H__
26 #define __PACKET_DIS_FIELDPARSERS_H__
27
28 #include <epan/packet.h>
29
30 extern int hf_dis_proto_ver;
31 extern int hf_dis_exercise_id;
32 extern int hf_dis_pdu_type;
33 extern int hf_dis_proto_fam;
34 extern int hf_dis_pdu_length;
35 extern int hf_dis_entity_id_site;
36 extern int hf_dis_entity_id_application;
37 extern int hf_dis_entity_id_entity;
38 extern int hf_dis_num_art_params;
39 extern int hf_dis_entityKind;
40 extern int hf_dis_entityDomain;
41 extern int hf_dis_category_land;
42 extern int hf_dis_category_air;
43 extern int hf_dis_category_surface;
44 extern int hf_dis_category_subsurface;
45 extern int hf_dis_category_space;
46 extern int hf_dis_category_radio;
47 extern int hf_dis_num_electromagnetic_emission_systems;
48 extern int hf_dis_emitter_name;
49 extern int hf_dis_emission_function;
50 extern int hf_dis_beam_function;
51 extern int hf_dis_radio_id;
52 extern int hf_dis_ens;
53 extern int hf_dis_ens_class;
54 extern int hf_dis_ens_type;
55 extern int hf_dis_tdl_type;
56 extern int hf_dis_sample_rate;
57 extern int hf_dis_data_length;
58 extern int hf_dis_num_of_samples;
59 extern int hf_dis_signal_data;
60 extern int hf_dis_radio_category;
61 extern int hf_dis_nomenclature_version;
62 extern int hf_dis_nomenclature;
63 extern int hf_dis_radio_transmit_state;
64 extern int hf_dis_radio_input_source;
65 extern int hf_dis_antenna_pattern_type;
66 extern int hf_dis_antenna_pattern_length;
67 extern int hf_dis_transmit_frequency;
68 extern int hf_dis_spread_spectrum_usage;
69 extern int hf_dis_frequency_hopping;
70 extern int hf_dis_pseudo_noise_modulation;
71 extern int hf_dis_time_hopping;
72 extern int hf_dis_modulation_major;
73 extern int hf_dis_modulation_system;
74 extern int hf_dis_crypto_system;
75 extern int hf_dis_crypto_key;
76 extern int hf_dis_encryption_mode;
77 extern int hf_dis_key_identifier;
78 extern int hf_dis_modulation_parameter_length;
79 extern int hf_dis_mod_param_fh_net_id;
80 extern int hf_dis_mod_param_fh_set_id;
81 extern int hf_dis_mod_param_fh_lo_set_id;
82 extern int hf_dis_mod_param_fh_msg_start;
83 extern int hf_dis_mod_param_fh_reserved;
84 extern int hf_dis_mod_param_fh_sync_time_offset;
85 extern int hf_dis_mod_param_fh_security_key;
86 extern int hf_dis_mod_param_fh_clear_channel;
87 extern int hf_dis_mod_param_dump;
88 extern int hf_dis_mod_param_ts_allocation_mode;
89 extern int hf_dis_mod_param_transmitter_prim_mode;
90 extern int hf_dis_mod_param_transmitter_second_mode;
91 extern int hf_dis_mod_param_sync_state;
92 extern int hf_dis_mod_param_network_sync_id;
93 extern int hf_dis_antenna_pattern_parameter_dump;
94 extern int hf_dis_num_shafts;
95 extern int hf_dis_num_apas;
96 extern int hf_dis_num_ua_emitter_systems;
97
98 extern int ett_dis_ens;
99 extern int ett_dis_crypto_key;
100
101
102
103 /* enumeration of all field types used for DIS parsing. */
104 typedef enum
105 {
106     /* end marker to indicate the end of a parser sequence */
107     DIS_FIELDTYPE_END = 0,
108
109     /* basic numeric types */
110     DIS_FIELDTYPE_INT8,
111     DIS_FIELDTYPE_INT16,
112     DIS_FIELDTYPE_INT32,
113     DIS_FIELDTYPE_INT64,
114     DIS_FIELDTYPE_UINT8,
115     DIS_FIELDTYPE_UINT16,
116     DIS_FIELDTYPE_UINT32,
117     DIS_FIELDTYPE_UINT64,
118     DIS_FIELDTYPE_FLOAT32,
119     DIS_FIELDTYPE_FLOAT64,
120
121     /* padding */
122     DIS_FIELDTYPE_PAD8,
123     DIS_FIELDTYPE_PAD16,
124     DIS_FIELDTYPE_PAD24,
125     DIS_FIELDTYPE_PAD32,
126
127     /* enumerations */
128     DIS_FIELDTYPE_ACKNOWLEDGE_FLAG,
129     DIS_FIELDTYPE_ACTION_ID,
130     DIS_FIELDTYPE_APPLICATION_GENERAL_STATUS,
131     DIS_FIELDTYPE_APPLICATION_STATUS_TYPE,
132     DIS_FIELDTYPE_APPLICATION_TYPE,
133     DIS_FIELDTYPE_CATEGORY,
134     DIS_FIELDTYPE_CONTROL_ID,
135     DIS_FIELDTYPE_DETONATION_RESULT,
136     DIS_FIELDTYPE_DOMAIN,
137     DIS_FIELDTYPE_ENTITY_KIND,
138     DIS_FIELDTYPE_FROZEN_BEHAVIOR,
139     DIS_FIELDTYPE_PARAMETER_TYPE_DESIGNATOR,
140     DIS_FIELDTYPE_PDU_TYPE,
141     DIS_FIELDTYPE_PERSISTENT_OBJECT_TYPE,
142     DIS_FIELDTYPE_PERSISTENT_OBJECT_CLASS,
143     DIS_FIELDTYPE_PROTOCOL_FAMILY,
144     DIS_FIELDTYPE_PROTOCOL_VERSION,
145     DIS_FIELDTYPE_REASON,
146     DIS_FIELDTYPE_REQUEST_STATUS,
147     DIS_FIELDTYPE_REQUIRED_RELIABILITY_SERVICE,
148     DIS_FIELDTYPE_RESPONSE_FLAG,
149     DIS_FIELDTYPE_TDL_TYPE,
150     DIS_FIELDTYPE_RADIO_CATEGORY,
151     DIS_FIELDTYPE_NOMENCLATURE_VERSION,
152     DIS_FIELDTYPE_NOMENCLATURE,
153     DIS_FIELDTYPE_RADIO_TRANSMIT_STATE,
154     DIS_FIELDTYPE_RADIO_INPUT_SOURCE,
155     DIS_FIELDTYPE_ANTENNA_PATTERN_TYPE,
156     DIS_FIELDTYPE_SPREAD_SPECTRUM,
157     DIS_FIELDTYPE_MODULATION_MAJOR,
158     DIS_FIELDTYPE_MODULATION_DETAIL,
159     DIS_FIELDTYPE_MODULATION_SYSTEM,
160     DIS_FIELDTYPE_CRYPTO_SYSTEM,
161     DIS_FIELDTYPE_EMITTER_NAME,
162     DIS_FIELDTYPE_EMISSION_FUNCTION,
163     DIS_FIELDTYPE_BEAM_FUNCTION,
164
165     /* other atomic types */
166     DIS_FIELDTYPE_PDU_LENGTH,
167     DIS_FIELDTYPE_EXERCISE_ID,
168     DIS_FIELDTYPE_SITE,
169     DIS_FIELDTYPE_APPLICATION,
170     DIS_FIELDTYPE_ENTITY,
171     DIS_FIELDTYPE_APPEARANCE,
172     DIS_FIELDTYPE_ARTIC_PARAM_TYPE,
173     DIS_FIELDTYPE_CAPABILITIES,
174     DIS_FIELDTYPE_COUNTRY,
175     DIS_FIELDTYPE_DATUM_ID,
176     DIS_FIELDTYPE_DATUM_LENGTH,
177     DIS_FIELDTYPE_DEAD_RECKONING_PARAMS,
178     DIS_FIELDTYPE_DEAD_RECKONING_ALGORITHM,
179     DIS_FIELDTYPE_DEAD_RECKONING_OTHER_PARAMS,
180     DIS_FIELDTYPE_ENTITY_MARKING,
181     DIS_FIELDTYPE_EXTRA,
182     DIS_FIELDTYPE_FIXED_DATUM_VALUE,
183     DIS_FIELDTYPE_FIXED_LEN_STR,
184     DIS_FIELDTYPE_FORCE_ID,
185     DIS_FIELDTYPE_FUSE,
186     DIS_FIELDTYPE_NUM_FIXED_DATA,
187     DIS_FIELDTYPE_NUM_VARIABLE_DATA,
188     DIS_FIELDTYPE_REQUEST_ID,
189     DIS_FIELDTYPE_SPECIFIC,
190     DIS_FIELDTYPE_SUBCATEGORY,
191     DIS_FIELDTYPE_TIME_INTERVAL,
192     DIS_FIELDTYPE_TIMESTAMP,
193     DIS_FIELDTYPE_WARHEAD,
194     DIS_FIELDTYPE_RADIO_ID,
195     DIS_FIELDTYPE_SAMPLE_RATE,
196     DIS_FIELDTYPE_DATA_LENGTH,
197     DIS_FIELDTYPE_NUMBER_OF_SAMPLES,
198     DIS_FIELDTYPE_NUM_ARTICULATION_PARAMS,
199     DIS_FIELDTYPE_ANTENNA_PATTERN_LENGTH,
200     DIS_FIELDTYPE_TRANSMIT_FREQUENCY,
201     DIS_FIELDTYPE_MODULATION_PARAMETER_LENGTH,
202     DIS_FIELDTYPE_FH_NETWORK_ID,
203     DIS_FIELDTYPE_FH_SET_ID,
204     DIS_FIELDTYPE_LO_SET_ID,
205     DIS_FIELDTYPE_FH_MSG_START,
206     DIS_FIELDTYPE_RESERVED,
207     DIS_FIELDTYPE_FH_SYNC_TIME_OFFSET,
208     DIS_FIELDTYPE_FH_SECURITY_KEY,
209     DIS_FIELDTYPE_FH_CLEAR_CHANNEL,
210     DIS_FIELDTYPE_TS_ALLOCATION_MODE,
211     DIS_FIELDTYPE_TRANSMITTER_PRIMARY_MODE,
212     DIS_FIELDTYPE_TRANSMITTER_SECONDARY_MODE,
213     DIS_FIELDTYPE_JTIDS_SYNC_STATE,
214     DIS_FIELDTYPE_NETWORK_SYNC_ID,
215     DIS_FIELDTYPE_NUM_ELECTROMAGNETIC_EMISSION_SYSTEMS,
216     DIS_FIELDTYPE_NUM_OF_SHAFTS,
217     DIS_FIELDTYPE_NUM_OF_APAS,
218     DIS_FIELDTYPE_NUM_OF_UA_EMITTER_SYSTEMS,
219     DIS_FIELDTYPE_NUM_OF_UA_EMITTER_SYSTEM_BEAMS,
220
221         /* composite types */
222     DIS_FIELDTYPE_BURST_DESCRIPTOR,
223     DIS_FIELDTYPE_CLOCK_TIME,
224     DIS_FIELDTYPE_ENTITY_ID,
225     DIS_FIELDTYPE_ENTITY_TYPE,
226     DIS_FIELDTYPE_RADIO_ENTITY_TYPE,
227     DIS_FIELDTYPE_EVENT_ID,
228     DIS_FIELDTYPE_LINEAR_VELOCITY,
229     DIS_FIELDTYPE_LOCATION_ENTITY,
230     DIS_FIELDTYPE_LOCATION_WORLD,
231     DIS_FIELDTYPE_ORIENTATION,
232     DIS_FIELDTYPE_SIMULATION_ADDRESS,
233     DIS_FIELDTYPE_VARIABLE_DATUM_VALUE,
234     DIS_FIELDTYPE_VECTOR_32,
235     DIS_FIELDTYPE_VECTOR_64,
236     DIS_FIELDTYPE_ENCODING_SCHEME,
237     DIS_FIELDTYPE_ANTENNA_LOCATION,
238     DIS_FIELDTYPE_REL_ANTENNA_LOCATON,
239     DIS_FIELDTYPE_MODULATION_TYPE,
240     DIS_FIELDTYPE_CRYPTO_KEY_ID,
241     DIS_FIELDTYPE_MODULATION_PARAMETERS,
242     DIS_FIELDTYPE_ANTENNA_PATTERN_PARAMETERS,
243     DIS_FIELDTYPE_MOD_PARAMS_CCTT_SINCGARS,
244     DIS_FIELDTYPE_MOD_PARAMS_JTIDS_MIDS,
245     DIS_FIELDTYPE_ELECTROMAGNETIC_EMISSION_SYSTEM_BEAM,
246     DIS_FIELDTYPE_ELECTROMAGNETIC_EMISSION_SYSTEM,
247     DIS_FIELDTYPE_EMITTER_SYSTEM,
248     DIS_FIELDTYPE_FUNDAMENTAL_PARAMETER_DATA,
249     DIS_FIELDTYPE_TRACK_JAM,
250     DIS_FIELDTYPE_SHAFTS,
251     DIS_FIELDTYPE_APA,
252     DIS_FIELDTYPE_UA_EMITTER_SYSTEMS,
253     DIS_FIELDTYPE_UA_BEAMS,
254     DIS_FIELDTYPE_UA_EMITTER_SYSTEM,
255     DIS_FIELDTYPE_UA_BEAM_FUNDAMENTAL_PARAMETER_DATA,
256
257     /* arrays */
258     DIS_FIELDTYPE_FIXED_DATUMS,
259     DIS_FIELDTYPE_FIXED_DATUM_IDS,
260     DIS_FIELDTYPE_VARIABLE_DATUMS,
261     DIS_FIELDTYPE_VARIABLE_DATUM_IDS,
262     DIS_FIELDTYPE_VARIABLE_PARAMETERS,
263     DIS_FIELDTYPE_VARIABLE_RECORDS,
264     DIS_FIELDTYPE_RADIO_DATA
265
266 } DIS_FieldType;
267
268 /* Struct which contains the data needed to parse a single DIS field.
269  */
270 typedef struct DIS_ParserNode_T
271 {
272     DIS_FieldType fieldType;
273     const char *fieldLabel;
274     int fieldRepeatLen;
275     int ettVar;
276     struct DIS_ParserNode_T *children;
277     guint32 *outputVar;
278 } DIS_ParserNode;
279
280 /* Struct which associates a name with a particular bit combination.
281  */
282 typedef struct
283 {
284     guint32 value;
285     const char *label;
286 } DIS_BitMaskMapping;
287
288 /* Struct which specifies all possible bit mappings associated with
289  * a particular bit mask.
290  */
291 typedef struct
292 {
293     guint32 maskBits;
294     guint32 shiftBits;
295     const char *label;
296     DIS_BitMaskMapping bitMappings[33];
297 } DIS_BitMask;
298
299 /* Headers */
300 extern DIS_ParserNode DIS_FIELDS_PDU_HEADER[];
301 extern DIS_ParserNode DIS_FIELDS_PERSISTENT_OBJECT_HEADER[];
302
303 /* Composite types */
304 extern DIS_ParserNode DIS_FIELDS_BURST_DESCRIPTOR[];
305 extern DIS_ParserNode DIS_FIELDS_CLOCK_TIME[];
306 extern DIS_ParserNode DIS_FIELDS_ENTITY_ID[];
307 extern DIS_ParserNode DIS_FIELDS_ENTITY_TYPE[];
308 extern DIS_ParserNode DIS_FIELDS_RADIO_ENTITY_TYPE[];
309 extern DIS_ParserNode DIS_FIELDS_MODULATION_TYPE[];
310 extern DIS_ParserNode DIS_FIELDS_EVENT_ID[];
311 extern DIS_ParserNode DIS_FIELDS_ORIENTATION[];
312 extern DIS_ParserNode DIS_FIELDS_SIMULATION_ADDRESS[];
313 extern DIS_ParserNode DIS_FIELDS_VECTOR_FLOAT_32[];
314 extern DIS_ParserNode DIS_FIELDS_VECTOR_FLOAT_64[];
315 extern DIS_ParserNode DIS_FIELDS_MOD_PARAMS_CCTT_SINCGARS[];
316 extern DIS_ParserNode DIS_FIELDS_MOD_PARAMS_JTIDS_MIDS[];
317 extern DIS_ParserNode DIS_FIELDS_EMITTER_SYSTEM[];
318 extern DIS_ParserNode DIS_FIELDS_FUNDAMENTAL_PARAMETER_DATA[];
319 extern DIS_ParserNode DIS_FIELDS_TRACK_JAM[];
320 extern DIS_ParserNode DIS_FIELDS_UA_EMITTER_SYSTEM[];
321 extern DIS_ParserNode DIS_FIELDS_UA_BEAM_FUNDAMENTAL_PARAMETER_DATA[];
322
323 /* Array records */
324 extern DIS_ParserNode DIS_FIELDS_FIXED_DATUM[];
325 extern DIS_ParserNode DIS_FIELDS_VARIABLE_DATUM[];
326 extern DIS_ParserNode DIS_FIELDS_DATUM_IDS[];
327 extern DIS_ParserNode DIS_FIELDS_VP_TYPE[];
328 extern DIS_ParserNode DIS_FIELDS_VR_TYPE[];
329 extern DIS_ParserNode DIS_FIELDS_VR_ELECTROMAGNETIC_EMISSION_SYSTEM_BEAM[];
330 extern DIS_ParserNode DIS_FIELDS_VR_ELECTROMAGNETIC_EMISSION_SYSTEM[];
331 extern DIS_ParserNode DIS_FIELDS_VR_UA_SHAFT[];
332 extern DIS_ParserNode DIS_FIELDS_VR_APA[];
333 extern DIS_ParserNode DIS_FIELDS_VR_UA_EMITTER_SYSTEM[];
334 extern DIS_ParserNode DIS_FIELDS_VR_UA_BEAM[];
335
336 /* Bit fields */
337 extern DIS_ParserNode DIS_FIELDS_NONE[];
338 extern DIS_BitMask DIS_APPEARANCE_LANDPLATFORM[];
339 extern DIS_BitMask DIS_APPEARANCE_LIFEFORM[];
340
341 extern void initializeFieldParsers(void);
342
343 extern gint parseField_Bytes(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode, guint numBytes);
344
345 extern gint parseField_Bitmask(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode, guint numBytes);
346
347 extern gint parseField_UInt(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode, guint numBytes);
348
349 extern gint parseField_Int(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode, guint numBytes);
350
351 extern gint parseField_Enum(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode, guint numBytes);
352
353 extern gint parseField_Pad(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode, guint numBytes);
354
355 extern gint parseField_Float(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode);
356
357 extern gint parseField_Double(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode);
358
359 extern gint parseField_Timestamp(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode);
360
361 extern gint parseField_VariableParameter(tvbuff_t *tvb, proto_tree *tree, gint offset);
362
363 extern gint parseField_VariableRecord(tvbuff_t *tvb, proto_tree *tree, gint offset);
364
365 extern gint parseField_ElectromagneticEmissionSystemBeam(tvbuff_t *tvb, proto_tree *tree, gint offset);
366
367 extern guint32 disProtocolVersion;
368 extern guint32 pduType;
369 extern guint32 protocolFamily;
370 extern guint32 persistentObjectPduType;
371 extern guint32 entityKind;
372 extern guint32 entityDomain;
373 extern guint32 radioID;
374 extern guint32 disRadioTransmitState;
375 extern guint32 encodingScheme;
376 extern guint32 numSamples;
377 extern guint32 numFixed;
378 extern guint32 numVariable;
379 extern guint32 numBeams;
380 extern guint32 numTrackJamTargets;
381 extern guint32 numShafts;
382 extern guint32 numApas;
383 extern guint32 numUAEmitter;
384 extern guint32 numUABeams;
385 extern guint32 variableDatumLength;
386 extern guint32 variableRecordLength;
387 extern guint32 majorModulation;
388 extern guint32 systemModulation;
389 extern guint32 modulationParamLength;
390 extern guint32 disAntennaPattern;
391
392
393 #endif /* packet-dis-fieldparsers.h */