epan/dissectors/packet-hsr.c

   1 /* packet-hsr.c
   2  * Routines for HSR dissection (IEC62439 Part 3)
   3  * Copyright 2009, Florian Reichert <refl[AT]zhaw.ch>
   4  *
   5  * Wireshark - Network traffic analyzer
   6  * By Gerald Combs <gerald[AT]wireshark.org>
   7  * Copyright 1998 Gerald Combs
   8  *
   9  * SPDX-License-Identifier: GPL-2.0-or-later
  10  */
  11
  12 #include "config.h"
  13
  14 #include <epan/packet.h>
  15 #include <epan/etypes.h>
  16
  17 void proto_register_hsr(void);
  18 void proto_reg_handoff_hsr(void);
  19
  20 static dissector_handle_t hsr_frame_handle;
  21
  22 /**********************************************************/
  23 /* Lengths of fields within a HSR packet.                 */
  24 /**********************************************************/
  25 #define HSR_LSDU_PATH_LENGTH                 2
  26 #define HSR_SEQUENZNR_LENGTH                 2
  27
  28 #define HSR_TOTAL_LENGTH                     4
  29
  30 /**********************************************************/
  31 /* Offsets of fields within a HSR packet.                 */
  32 /**********************************************************/
  33 #define HSR_PATH_OFFSET                      0
  34 #define HSR_SEQUENZNR_OFFSET                 2
  35
  36 static const value_string hsr_laneid_vals[] = {
  37     {0, "Lane A"},
  38     {1, "Lane B"},
  39     {0, NULL}
  40 };
  41
  42 /**********************************************************/
  43 /* Initialize the protocol and registered fields          */
  44 /**********************************************************/
  45
  46 static int proto_hsr;
  47
  48 /* Initialize supervision frame fields */
  49
  50
  51 static int hf_hsr_path;
  52 static int hf_hsr_netid;
  53 static int hf_hsr_laneid;
  54 static int hf_hsr_lsdu_size;
  55 static int hf_hsr_sequence_nr;
  56 static int hf_type;
  57
  58 static dissector_table_t ethertype_subdissector_table;
  59 /* Initialize the subtree pointers */
  60 static int ett_hsr_frame;
  61
  62 /* Code to actually dissect the packets */
  63 static int
  64 dissect_hsr_frame(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data _U_)
  65 {
  66     proto_item *ti;
  67     proto_tree *hsr_tree;
  68     tvbuff_t *next_tvb;
  69     uint16_t etype;
  70     uint16_t lsdu_size, lsdu_size_correct;
  71
  72     col_set_str(pinfo->cinfo, COL_PROTOCOL, "HSR");
  73
  74     col_set_str(pinfo->cinfo, COL_INFO, "HSR-Data Frame");
  75
  76     /* create display subtree for the protocol */
  77
  78     ti = proto_tree_add_item(tree, proto_hsr, tvb, 0, HSR_TOTAL_LENGTH, ENC_NA);
  79
  80     hsr_tree = proto_item_add_subtree(ti, ett_hsr_frame);
  81
  82     proto_tree_add_item(hsr_tree, hf_hsr_path,
  83                         tvb, HSR_PATH_OFFSET, HSR_LSDU_PATH_LENGTH , ENC_BIG_ENDIAN);
  84
  85     proto_tree_add_item(hsr_tree, hf_hsr_netid,
  86                         tvb, HSR_PATH_OFFSET, HSR_LSDU_PATH_LENGTH , ENC_BIG_ENDIAN);
  87
  88     proto_tree_add_item(hsr_tree, hf_hsr_laneid,
  89                         tvb, HSR_PATH_OFFSET, HSR_LSDU_PATH_LENGTH , ENC_BIG_ENDIAN);
  90
  91
  92     lsdu_size = tvb_get_ntohs(tvb, HSR_PATH_OFFSET) & 0x0fff;
  93     lsdu_size_correct = tvb_reported_length_remaining(tvb, 0);
  94     if (lsdu_size == lsdu_size_correct) {
  95         proto_tree_add_uint_format_value(hsr_tree, hf_hsr_lsdu_size,
  96                                    tvb, HSR_PATH_OFFSET, HSR_LSDU_PATH_LENGTH, lsdu_size,
  97                                    "%d [correct]", lsdu_size);
  98     } else {
  99         proto_tree_add_uint_format_value(hsr_tree, hf_hsr_lsdu_size,
 100                                    tvb, HSR_PATH_OFFSET, HSR_LSDU_PATH_LENGTH, lsdu_size,
 101                                    "%d [WRONG, should be %d]", lsdu_size, lsdu_size_correct);
 102     }
 103
 104     proto_tree_add_item(hsr_tree, hf_hsr_sequence_nr,
 105                         tvb, HSR_SEQUENZNR_OFFSET,HSR_SEQUENZNR_LENGTH, ENC_BIG_ENDIAN);
 106
 107     proto_tree_add_item(hsr_tree, hf_type,
 108                         tvb, HSR_TOTAL_LENGTH,2, ENC_BIG_ENDIAN);
 109
 110     next_tvb = tvb_new_subset_remaining(tvb, HSR_TOTAL_LENGTH + 2);
 111
 112     etype = tvb_get_ntohs(tvb, HSR_TOTAL_LENGTH);
 113
 114     if (!dissector_try_uint(ethertype_subdissector_table, etype, next_tvb, pinfo, tree))
 115         call_data_dissector(next_tvb, pinfo, hsr_tree);
 116
 117     return tvb_captured_length(tvb);
 118 }
 119
 120
 121
 122 /* Register the protocol with Wireshark */
 123 void proto_register_hsr(void)
 124 {
 125     static hf_register_info hf[] = {
 126         { &hf_hsr_path,
 127           { "Path", "hsr.path",
 128             FT_UINT16, BASE_DEC, NULL, 0xf000,
 129             NULL, HFILL }
 130         },
 131
 132         { &hf_hsr_netid,
 133           { "Network id", "hsr.netid",
 134             FT_UINT16, BASE_DEC, NULL, 0xe000,
 135             NULL, HFILL }
 136         },
 137
 138         { &hf_hsr_laneid,
 139           { "Lane id", "hsr.laneid",
 140             FT_UINT16, BASE_DEC, VALS(hsr_laneid_vals), 0x1000,
 141             NULL, HFILL }
 142         },
 143
 144         { &hf_hsr_lsdu_size,
 145           { "LSDU size", "hsr.lsdu_size",
 146             FT_UINT16, BASE_DEC, NULL, 0x0fff,
 147             NULL, HFILL }
 148         },
 149
 150         { &hf_hsr_sequence_nr,
 151           { "Sequence number", "hsr.sequence_nr",
 152             FT_UINT16, BASE_DEC, NULL, 0x00,
 153             NULL, HFILL }
 154         },
 155         { &hf_type,
 156           { "Type", "hsr.type",
 157             FT_UINT16, BASE_HEX, VALS(etype_vals), 0x00,
 158             NULL, HFILL }
 159         }
 160
 161     };
 162
 163     static int *ett[] = {
 164         &ett_hsr_frame,
 165     };
 166
 167     /* Register the protocol name and description */
 168     proto_hsr = proto_register_protocol("High-availability Seamless Redundancy (IEC62439 Part 3 Chapter 5)",
 169                                         "HSR", "hsr");
 170
 171     /* Required function calls to register the header fields and subtree used */
 172     proto_register_field_array(proto_hsr, hf, array_length(hf));
 173     proto_register_subtree_array(ett, array_length(ett));
 174
 175     hsr_frame_handle = register_dissector("hsr", dissect_hsr_frame, proto_hsr);
 176 }
 177
 178
 179 void proto_reg_handoff_hsr(void)
 180 {
 181     dissector_add_uint("ethertype", ETHERTYPE_HSR, hsr_frame_handle);
 182
 183     ethertype_subdissector_table = find_dissector_table("ethertype");
 184 }
 185
 186 /*
 187  * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 188  *
 189  * Local variables:
 190  * c-basic-offset: 4
 191  * tab-width: 8
 192  * indent-tabs-mode: nil
 193  * End:
 194  *
 195  * vi: set shiftwidth=4 tabstop=8 expandtab:
 196  * :indentSize=4:tabSize=8:noTabs=true:
 197  */