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