epan/dissectors/packet-hsr-prp-supervision.c

   1 /* packet-hsr-prp-supervision.c
   2  * Routines for HSR/PRP supervision dissection (IEC62439 Part 3)
   3  * Copyright 2009, Florian Reichert <refl[AT]zhaw.ch>
   4  * Copyright 2011, Martin Renold <reld[AT]zhaw.ch>
   5  *
   6  * $Id$
   7  *
   8  * Wireshark - Network traffic analyzer
   9  * By Gerald Combs <gerald[AT]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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  25  */
  26
  27 #include "config.h"
  28
  29 #include <glib.h>
  30 #include <epan/packet.h>
  31 #include <epan/etypes.h>
  32
  33 /**********************************************************/
  34 /* Channel values for the supervision type field          */
  35 /**********************************************************/
  36
  37 static const value_string type_vals[] = {
  38   {20, "PRP Node (Duplicate Discard)"},
  39   {21, "PRP Node (Duplicate Accept)"},
  40   {22, "Obsolete TLV value"},
  41   {23, "HSR Node"},
  42   {30, "Redundancy Box MAC Address"},
  43   {31, "Virtual Dual Attached Node"},
  44   {0,  "End of TLVs"},
  45   {0,  NULL}
  46 };
  47
  48 /**********************************************************/
  49 /* Initialize the protocol and registered fields          */
  50 /**********************************************************/
  51
  52 static int proto_hsr_prp_supervision = -1;
  53
  54 /* Initialize supervision frame fields */
  55 static int hf_hsr_prp_supervision_path = -1;
  56 static int hf_hsr_prp_supervision_version = -1;
  57 static int hf_hsr_prp_supervision_seqno = -1;
  58 static int hf_hsr_prp_supervision_tlv_type = -1;
  59 static int hf_hsr_prp_supervision_tlv_length = -1;
  60 static int hf_hsr_prp_supervision_source_mac_address_A = -1;
  61 static int hf_hsr_prp_supervision_source_mac_address_B = -1;
  62 static int hf_hsr_prp_supervision_source_mac_address = -1;
  63 static int hf_hsr_prp_supervision_red_box_mac_address = -1;
  64 static int hf_hsr_prp_supervision_vdan_mac_address = -1;
  65
  66 /* Initialize the subtree pointers */
  67 static gint ett_hsr_prp_supervision = -1;
  68
  69 /* Code to actually dissect the packets */
  70 static void
  71 dissect_hsr_prp_supervision(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
  72 {
  73     proto_item *ti;
  74     proto_tree *hsr_prp_supervision_tree;
  75     guint8 tlv_type;
  76     guint8 tlv_length;
  77     guint16 sup_version;
  78     int offset;
  79
  80     col_set_str(pinfo->cinfo, COL_PROTOCOL, "HSR/PRP");
  81
  82     /* may get modified later while parsing */
  83     col_set_str(pinfo->cinfo, COL_INFO, "HSR or PRP Supervision");
  84
  85     /* create display subtree for the protocol */
  86     ti = proto_tree_add_item(tree, proto_hsr_prp_supervision, tvb, 0, -1, ENC_NA);
  87
  88     hsr_prp_supervision_tree = proto_item_add_subtree(ti, ett_hsr_prp_supervision);
  89
  90     offset = 0;
  91
  92     /* SupVersion */
  93     proto_tree_add_item(hsr_prp_supervision_tree, hf_hsr_prp_supervision_path,
  94                         tvb, offset, 2, ENC_BIG_ENDIAN);
  95     proto_tree_add_item(hsr_prp_supervision_tree, hf_hsr_prp_supervision_version,
  96                         tvb, offset, 2, ENC_BIG_ENDIAN);
  97     sup_version = tvb_get_ntohs(tvb, 0) & 0x0fff;
  98     offset += 2;
  99
 100     if (sup_version > 0) {
 101         /* SupSequenceNumber */
 102         proto_tree_add_item(hsr_prp_supervision_tree, hf_hsr_prp_supervision_seqno,
 103                             tvb, offset, 2, ENC_BIG_ENDIAN);
 104         offset += 2;
 105     }
 106
 107     while (tvb_reported_length_remaining(tvb, offset) > 0) {
 108         /* TLV.type */
 109         tlv_type = tvb_get_guint8(tvb, offset);
 110         proto_tree_add_item(hsr_prp_supervision_tree, hf_hsr_prp_supervision_tlv_type,
 111                             tvb, offset, 1, ENC_BIG_ENDIAN);
 112         offset += 1;
 113
 114         /* TLV.length */
 115         tlv_length = tvb_get_guint8(tvb, offset);
 116         proto_tree_add_item(hsr_prp_supervision_tree, hf_hsr_prp_supervision_tlv_length,
 117                             tvb, offset, 1, ENC_BIG_ENDIAN);
 118         offset += 1;
 119
 120         /* TLV.value */
 121         if ((tlv_type == 20 || tlv_type == 21 || tlv_type == 23) && (tlv_length == 6 || tlv_length == 12)) {
 122             if (tlv_type == 23) {
 123                 col_set_str(pinfo->cinfo, COL_INFO, "HSR Supervision");
 124             } else {
 125                 col_set_str(pinfo->cinfo, COL_INFO, "PRP Supervision");
 126             }
 127             if (tlv_length == 12) {
 128                 /* MacAddressA, MacAddressB (PRP only) */
 129                 proto_tree_add_item(hsr_prp_supervision_tree, hf_hsr_prp_supervision_source_mac_address_A,
 130                                     tvb, offset, 6, ENC_NA);
 131                 proto_tree_add_item(hsr_prp_supervision_tree, hf_hsr_prp_supervision_source_mac_address_B,
 132                                     tvb, offset+6, 6, ENC_NA);
 133                 /* PRP-0 supervision: if the node is not a RedBox, we have
 134                    just read the last TLV. The next two octets are
 135                    required to be zero by PRP-0. We will dissect those as
 136                    "end of list" and break. */
 137             } else {
 138                 /* MacAddress */
 139                 proto_tree_add_item(hsr_prp_supervision_tree, hf_hsr_prp_supervision_source_mac_address,
 140                                     tvb, offset, 6, ENC_NA);
 141             }
 142         } else if (tlv_type == 30 && tlv_length == 6) {
 143             /* RedBoxMacAddress */
 144             proto_tree_add_item(hsr_prp_supervision_tree, hf_hsr_prp_supervision_red_box_mac_address,
 145                                 tvb, offset, 6, ENC_NA);
 146             if (sup_version == 0) {
 147                 /* PRP-0 supervision: end of TLV data. Stop now, don't
 148                    interpret the padding. */
 149                 offset += tlv_length;
 150                 break;
 151             }
 152         } else if (tlv_type == 31 && tlv_length == 6) {
 153             /* VdanMacAddress */
 154             proto_tree_add_item(hsr_prp_supervision_tree, hf_hsr_prp_supervision_vdan_mac_address,
 155                                 tvb, offset, 6, ENC_NA);
 156             if (sup_version == 0) {
 157                 /* PRP-0 supervision: end of TLV data, padding starts */
 158                 offset += tlv_length;
 159                 break;
 160             }
 161         } else if (tlv_type == 0) {
 162             /* End of TLV list. */
 163             offset += tlv_length;
 164             break;
 165         } else {
 166             /* unknown TLV.type, or unexpected TLV.length */
 167         }
 168         offset += tlv_length;
 169     }
 170
 171     proto_item_set_len(ti, offset);
 172     /* Adjust the length of this tvbuff to include only the supervision data.
 173        This allows the rest to be marked as padding. */
 174     tvb_set_reported_length(tvb, offset);
 175 }
 176
 177
 178 /* Register the protocol with Wireshark */
 179 void proto_register_hsr_prp_supervision(void)
 180 {
 181
 182     static hf_register_info hf[] = {
 183
 184         { &hf_hsr_prp_supervision_path,
 185             { "Path", "hsr_prp_supervision.path",
 186             FT_UINT16, BASE_DEC, NULL, 0xf000,
 187             NULL, HFILL }
 188         },
 189         { &hf_hsr_prp_supervision_version,
 190             { "Version", "hsr_prp_supervision.version",
 191             FT_UINT16, BASE_DEC, NULL, 0x0fff,
 192             NULL, HFILL }
 193         },
 194         { &hf_hsr_prp_supervision_seqno,
 195             { "Sequence number", "hsr_prp_supervision.supervision_seqno",
 196             FT_UINT16, BASE_DEC, NULL, 0x00,
 197             NULL, HFILL }
 198         },
 199         { &hf_hsr_prp_supervision_tlv_type,
 200             { "TLV type", "hsr_prp_supervision.tlv.type",
 201             FT_UINT8, BASE_DEC, VALS(type_vals), 0x00,
 202             NULL, HFILL }
 203         },
 204         { &hf_hsr_prp_supervision_tlv_length,
 205             { "TLV length", "hsr_prp_supervision.tlv.length",
 206             FT_UINT8, BASE_DEC, NULL, 0x00,
 207             NULL, HFILL }
 208         },
 209         { &hf_hsr_prp_supervision_source_mac_address_A,
 210             { "Source MAC Address A", "hsr_prp_supervision.source_mac_address_A",
 211             FT_ETHER, BASE_NONE, NULL, 0x00,
 212             NULL, HFILL }
 213         },
 214         { &hf_hsr_prp_supervision_source_mac_address_B,
 215             { "Source MAC Address B", "hsr_prp_supervision.source_mac_address_B",
 216             FT_ETHER, BASE_NONE, NULL, 0x00,
 217             NULL, HFILL }
 218         },
 219         { &hf_hsr_prp_supervision_source_mac_address,
 220             { "Source MAC Address", "hsr_prp_supervision.source_mac_address",
 221             FT_ETHER, BASE_NONE, NULL, 0x00,
 222             NULL, HFILL }
 223         },
 224         { &hf_hsr_prp_supervision_red_box_mac_address,
 225             { "RedBox MAC Address", "hsr_prp_supervision.red_box_mac_address",
 226             FT_ETHER, BASE_NONE, NULL, 0x00,
 227             NULL, HFILL }
 228         },
 229         { &hf_hsr_prp_supervision_vdan_mac_address,
 230             { "VDAN MAC Address", "hsr_prp_supervision.vdan_mac_address",
 231             FT_ETHER, BASE_NONE, NULL, 0x00,
 232             NULL, HFILL }
 233         }
 234     };
 235
 236
 237     static gint *ett[] = {
 238         &ett_hsr_prp_supervision
 239     };
 240
 241     /* Register the protocol name and description */
 242     proto_hsr_prp_supervision = proto_register_protocol("HSR/PRP Supervision (IEC62439 Part 3)",
 243                         "HSR_PRP_SUPERVISION", "hsr_prp_supervision");
 244
 245
 246     /* Required function calls to register the header fields and subtree used */
 247     proto_register_field_array(proto_hsr_prp_supervision, hf, array_length(hf));
 248     proto_register_subtree_array(ett, array_length(ett));
 249 }
 250
 251
 252 void proto_reg_handoff_hsr_prp_supervision(void)
 253 {
 254     dissector_handle_t hsr_prp_supervision_handle;
 255     hsr_prp_supervision_handle = create_dissector_handle(dissect_hsr_prp_supervision, proto_hsr_prp_supervision);
 256     dissector_add_uint("ethertype", ETHERTYPE_PRP, hsr_prp_supervision_handle);
 257 }