Fix:
[obnox/wireshark/wip.git] / plugins / profinet / packet-pn-rt.c
1 /* packet-pn-rt.c
2  * Routines for pn-rt (PROFINET Real-Time) packet dissection.
3  * This is the base for other PROFINET protocols like IO, CBA, DCP, ...
4  * (the "content subdissectors" will register themselves using a heuristic)
5  *
6  * $Id$
7  *
8  * Wireshark - Network traffic analyzer
9  * By Gerald Combs <gerald@wireshark.org>
10  * Copyright 1999 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 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #ifdef HAVE_SYS_TYPES_H
32 # include <sys/types.h>
33 #endif
34
35 #ifdef HAVE_NETINET_IN_H
36 #include <netinet/in.h>
37 #endif
38
39 #include <epan/packet.h>
40 #include <epan/addr_resolv.h>
41 #include <epan/prefs.h>
42 #include <epan/strutil.h>
43 #include <epan/etypes.h>
44 #include <epan/expert.h>
45 #include <epan/dissectors/packet-dcerpc.h>
46 #include <epan/crc16-tvb.h>
47
48 #include "packet-pn.h"
49
50 /* Define the pn-rt proto */
51 static int proto_pn_rt     = -1;
52
53 /* Define many header fields for pn-rt */
54 static int hf_pn_rt_frame_id = -1;
55 static int hf_pn_rt_cycle_counter = -1;
56 static int hf_pn_rt_transfer_status = -1;
57 static int hf_pn_rt_data_status = -1;
58 static int hf_pn_rt_data_status_ignore = -1;
59 static int hf_pn_rt_data_status_Reserved_2 = -1;
60 static int hf_pn_rt_data_status_ok = -1;
61 static int hf_pn_rt_data_status_operate = -1;
62 static int hf_pn_rt_data_status_res3 = -1;
63 static int hf_pn_rt_data_status_valid = -1;
64 static int hf_pn_rt_data_status_redundancy = -1;
65 static int hf_pn_rt_data_status_primary = -1;
66
67 static int hf_pn_rt_sf_crc16 = -1;
68 static int hf_pn_rt_sf = -1;
69 static int hf_pn_rt_sf_position = -1;
70 static int hf_pn_rt_sf_position_control = -1;
71 static int hf_pn_rt_sf_data_length = -1;
72 static int hf_pn_rt_sf_cycle_counter = -1;
73
74 static int hf_pn_rt_frag = -1;
75 static int hf_pn_rt_frag_data_length = -1;
76 static int hf_pn_rt_frag_status = -1;
77 static int hf_pn_rt_frag_status_more_follows = -1;
78 static int hf_pn_rt_frag_status_error = -1;
79 static int hf_pn_rt_frag_status_fragment_number = -1;
80 static int hf_pn_rt_frag_data = -1;
81
82
83 /*
84  * Define the trees for pn-rt
85  * We need one tree for pn-rt itself and one for the pn-rt data status subtree
86  */
87 static int ett_pn_rt = -1;
88 static int ett_pn_rt_data_status = -1;
89 static int ett_pn_rt_sf = -1;
90 static int ett_pn_rt_frag = -1;
91 static int ett_pn_rt_frag_status = -1;
92
93 /*
94  * Here are the global variables associated with
95  * the various user definable characteristics of the dissection
96  */
97 /* Place summary in proto tree */
98 static gboolean pn_rt_summary_in_tree = TRUE;
99
100 /* heuristic to find the right pn-rt payload dissector */
101 static heur_dissector_list_t heur_subdissector_list;
102
103
104 static const value_string pn_rt_position_control[] = {
105     { 0x00, "CRC16 and CycleCounter shall not be checked" },
106     { 0x80, "CRC16 and CycleCounter valid" },
107     { 0, NULL }
108 };
109 static const value_string pn_rt_ds_redundancy[] = {
110         { 0x00, "One primary AR of a given AR-set is present" },
111         { 0x01, "None primary AR of a given AR-set is present" },
112     { 0, NULL }
113 };
114
115 static const value_string pn_rt_frag_status_error[] = {
116     { 0x00, "No error" },
117     { 0x01, "An error occured, all earlier fragments shall be dropped" },
118     { 0, NULL }
119 };
120
121 static const value_string pn_rt_frag_status_more_follows[] = {
122     { 0x00, "Last fragment" },
123     { 0x01, "More fragments follow" },
124     { 0, NULL }
125 };
126
127
128
129 static void
130 dissect_DataStatus(tvbuff_t *tvb, int offset, proto_tree *tree, guint8 u8DataStatus)
131 {
132     proto_item *sub_item;
133     proto_tree *sub_tree;
134
135     sub_item = proto_tree_add_uint_format(tree, hf_pn_rt_data_status,
136         tvb, offset, 1, u8DataStatus,
137         "DataStatus: 0x%02x (Frame: %s and %s, Provider: %s and %s)",
138         u8DataStatus,
139         (u8DataStatus & 0x04) ? "Valid" : "Invalid",
140         (u8DataStatus & 0x01) ? "Primary" : "Backup",
141         (u8DataStatus & 0x20) ? "Ok" : "Problem",
142         (u8DataStatus & 0x10) ? "Run" : "Stop");
143     sub_tree = proto_item_add_subtree(sub_item, ett_pn_rt_data_status);
144     proto_tree_add_uint(sub_tree, hf_pn_rt_data_status_ignore, tvb, offset, 1, u8DataStatus);
145     proto_tree_add_uint(sub_tree, hf_pn_rt_data_status_Reserved_2, tvb, offset, 1, u8DataStatus);
146     proto_tree_add_uint(sub_tree, hf_pn_rt_data_status_ok, tvb, offset, 1, u8DataStatus);
147     proto_tree_add_uint(sub_tree, hf_pn_rt_data_status_operate, tvb, offset, 1, u8DataStatus);
148     proto_tree_add_uint(sub_tree, hf_pn_rt_data_status_res3, tvb, offset, 1, u8DataStatus);
149     proto_tree_add_uint(sub_tree, hf_pn_rt_data_status_valid, tvb, offset, 1, u8DataStatus);
150     proto_tree_add_uint(sub_tree, hf_pn_rt_data_status_redundancy, tvb, offset, 1, u8DataStatus);
151     proto_tree_add_uint(sub_tree, hf_pn_rt_data_status_primary, tvb, offset, 1, u8DataStatus);
152 }
153
154
155 static gboolean IsDFP_Frame(tvbuff_t *tvb)
156 {
157         guint16 u16SFCRC16;
158         guint8  u8SFPosition;
159         guint8  u8SFDataLength   = 255;
160         int offset = 0;
161         guint32 u32SubStart;
162         guint16 crc;
163     gint tvb_len =0;
164
165     offset += 2;    /*Skip first crc because data is no more available */
166     tvb_len = tvb_length(tvb);
167     if(offset + 4 > tvb_len)
168         return FALSE;
169     while(1) {
170         u32SubStart = offset;
171
172         u8SFPosition = tvb_get_guint8(tvb, offset);
173         offset += 1;
174
175         u8SFDataLength = tvb_get_guint8(tvb, offset);
176         offset += 1;
177
178         if(u8SFDataLength == 0) {
179             break;
180         }
181
182         offset += 1;
183
184         offset += 1;
185
186         offset += u8SFDataLength;
187        if(offset > tvb_len)
188            return /*TRUE; */FALSE;
189
190         u16SFCRC16 = tvb_get_letohs(tvb, offset);
191         if(u16SFCRC16 != 0){
192             if(u8SFPosition & 0x80) {
193                 crc = crc16_plain_tvb_offset(tvb, u32SubStart, offset-u32SubStart);
194                 if(crc != u16SFCRC16) {
195                     return FALSE;
196                 } else {
197                 }
198             } else {
199             }
200         }
201         offset += 2;
202     }
203     return TRUE;
204 }
205
206 /* possibly dissect a CSF_SDU related PN-RT packet */
207 gboolean
208 dissect_CSF_SDU_heur(tvbuff_t *tvb,
209     packet_info *pinfo, proto_tree *tree)
210 {
211     guint16 u16FrameID;
212     guint16 u16SFCRC16;
213     guint8  u8SFPosition;
214     guint8  u8SFDataLength = 255;
215     guint8  u8SFCycleCounter;
216     guint8  u8SFDataStatus;
217         gint offset = 0;
218     guint32 u32SubStart;
219     proto_item *sub_item;
220     proto_tree *sub_tree;
221     proto_item *item;
222     guint16 crc;
223
224
225     /* the sub tvb will NOT contain the frame_id here! */
226     u16FrameID = GPOINTER_TO_UINT(pinfo->private_data);
227
228     /* possible FrameID ranges for DFP */
229     if((u16FrameID < 0x100) || (u16FrameID > 0x0fff))
230         return (FALSE);
231     if (IsDFP_Frame(tvb)) {
232         /* can't check this CRC, as the checked data bytes are not available */
233         u16SFCRC16 = tvb_get_letohs(tvb, offset);
234         proto_tree_add_uint(tree, hf_pn_rt_sf_crc16, tvb, offset, 2, u16SFCRC16);
235         offset += 2;
236
237         while(1) {
238             sub_item = proto_tree_add_item(tree, hf_pn_rt_sf, tvb, offset, 0, ENC_NA);
239             sub_tree = proto_item_add_subtree(sub_item, ett_pn_rt_sf);
240             u32SubStart = offset;
241
242             u8SFPosition = tvb_get_guint8(tvb, offset);
243             proto_tree_add_uint(sub_tree, hf_pn_rt_sf_position, tvb, offset, 1, u8SFPosition);
244             offset += 1;
245
246             u8SFDataLength = tvb_get_guint8(tvb, offset);
247             proto_tree_add_uint(sub_tree, hf_pn_rt_sf_data_length, tvb, offset, 1, u8SFDataLength);
248             offset += 1;
249
250             if(u8SFDataLength == 0) {
251                 proto_item_append_text(sub_item, ": Pos:%u, Length:%u", u8SFPosition, u8SFDataLength);
252                 proto_item_set_len(sub_item, offset - u32SubStart);
253                 break;
254             }
255
256             u8SFCycleCounter = tvb_get_guint8(tvb, offset);
257             proto_tree_add_uint(sub_tree, hf_pn_rt_sf_cycle_counter, tvb, offset, 1, u8SFCycleCounter);
258             offset += 1;
259
260             u8SFDataStatus = tvb_get_guint8(tvb, offset);
261             dissect_DataStatus(tvb, offset, sub_tree, u8SFDataStatus);
262             offset += 1;
263
264             offset = dissect_pn_user_data(tvb, offset, pinfo, sub_tree, u8SFDataLength, "DataItem");
265
266             u16SFCRC16 = tvb_get_letohs(tvb, offset);
267             item = proto_tree_add_uint(sub_tree, hf_pn_rt_sf_crc16, tvb, offset, 2, u16SFCRC16);
268
269             if(u16SFCRC16 != 0 /* "old check": u8SFPosition & 0x80 */) {
270                 crc = crc16_plain_tvb_offset(tvb, u32SubStart, offset-u32SubStart);
271                 if(crc != u16SFCRC16) {
272                     proto_item_append_text(item, " [Preliminary check: incorrect, should be: %u]", crc);
273                     expert_add_info_format(pinfo, item, PI_CHECKSUM, PI_ERROR, "Bad checksum");
274                 } else {
275                     proto_item_append_text(item, " [Preliminary check: Correct]");
276                 }
277             } else {
278                 proto_item_append_text(item, " [No check, supplied CRC == zero]");
279             }
280             offset += 2;
281
282             proto_item_append_text(sub_item, ": Pos:%u, Length:%u, Cycle:%u, Status: 0x%02x (%s,%s,%s,%s)",
283                 u8SFPosition, u8SFDataLength, u8SFCycleCounter, u8SFDataStatus,
284                 (u8SFDataStatus & 0x04) ? "Valid" : "Invalid",
285                 (u8SFDataStatus & 0x01) ? "Primary" : "Backup",
286                 (u8SFDataStatus & 0x20) ? "Ok" : "Problem",
287                 (u8SFDataStatus & 0x10) ? "Run" : "Stop");
288
289             proto_item_set_len(sub_item, offset - u32SubStart);
290         }
291
292         return TRUE;
293     }
294
295     return FALSE;
296
297 }
298
299
300 /* possibly dissect a FRAG_PDU related PN-RT packet */
301 static gboolean
302 dissect_FRAG_PDU_heur(tvbuff_t *tvb,
303     packet_info *pinfo, proto_tree *tree)
304 {
305     guint16 u16FrameID;
306     int offset = 0;
307     proto_item *sub_item;
308     proto_tree *sub_tree;
309     guint8  u8FragDataLength;
310     proto_item *status_item;
311     proto_tree *status_tree;
312     guint8  u8FragStatus;
313
314
315     /* the sub tvb will NOT contain the frame_id here! */
316     u16FrameID = GPOINTER_TO_UINT(pinfo->private_data);
317
318     /* possible FrameID ranges for FRAG_PDU */
319     if (u16FrameID >= 0xFF80 && u16FrameID <= 0xFF8F) {
320         sub_item = proto_tree_add_item(tree, hf_pn_rt_frag, tvb, offset, 0, ENC_NA);
321         sub_tree = proto_item_add_subtree(sub_item, ett_pn_rt_frag);
322
323         u8FragDataLength = tvb_get_guint8(tvb, offset);
324         proto_tree_add_uint(sub_tree, hf_pn_rt_frag_data_length, tvb, offset, 1, u8FragDataLength);
325         offset += 1;
326
327         status_item = proto_tree_add_item(sub_tree, hf_pn_rt_frag_status, tvb, offset, 1, ENC_NA);
328         status_tree = proto_item_add_subtree(status_item, ett_pn_rt_frag_status);
329
330         u8FragStatus = tvb_get_guint8(tvb, offset);
331         proto_tree_add_uint(status_tree, hf_pn_rt_frag_status_more_follows, tvb, offset, 1, u8FragStatus);
332         proto_tree_add_uint(status_tree, hf_pn_rt_frag_status_error, tvb, offset, 1, u8FragStatus);
333         proto_tree_add_uint(status_tree, hf_pn_rt_frag_status_fragment_number, tvb, offset, 1, u8FragStatus);
334         offset += 1;
335         proto_item_append_text(status_item, ": Number: %u, %s, %s",
336             u8FragStatus & 0x3F,
337             val_to_str( (u8FragStatus & 0x80) >> 7, pn_rt_frag_status_more_follows, "Unknown"),
338             val_to_str( (u8FragStatus & 0x40) >> 6, pn_rt_frag_status_error, "Unknown"));
339
340
341                 proto_tree_add_string_format(sub_tree, hf_pn_rt_frag_data, tvb, offset, tvb_length(tvb) - offset, "data", 
342             "FragData: %d bytes", tvb_length(tvb) - offset);
343
344         /* note: the actual defragmentation implementation is still missing here */
345         dissect_pn_undecoded(tvb, offset, pinfo, sub_tree, tvb_length(tvb) - offset);
346
347         return TRUE;
348     }
349
350     return FALSE;
351
352 }
353
354
355 /*
356  * dissect_pn_rt - The dissector for the Soft-Real-Time protocol
357  */
358 static void
359 dissect_pn_rt(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
360 {
361     gint pdu_len;
362     gint data_len;
363     guint16 u16FrameID;
364     guint8 u8DataStatus;
365     guint8 u8TransferStatus;
366     guint16 u16CycleCounter;
367     const gchar *pszProtAddInfo;
368     const gchar *pszProtShort;
369     const gchar *pszProtSummary;
370     const gchar *pszProtComment;
371     proto_tree *pn_rt_tree, *ti;
372     gchar szFieldSummary[100];
373     tvbuff_t *next_tvb;
374     gboolean  bCyclic;
375
376
377     /* If the link-layer dissector for the protocol above us knows whether
378      * the packet, as handed to it, includes a link-layer FCS, what it
379      * hands to us should not include the FCS; if that's not the case,
380      * that's a bug in that dissector, and should be fixed there.
381      *
382      * If the link-layer dissector for the protocol above us doesn't know
383      * whether the packet, as handed to us, includes a link-layer FCS,
384      * there are limits as to what can be done there; the dissector
385      * ultimately needs a "yes, it has an FCS" preference setting, which
386      * both the Ethernet and 802.11 dissectors do.  If that's not the case
387      * for a dissector, that's a deficiency in that dissector, and should
388      * be fixed there.
389      *
390      * Therefore, we assume we are not handed a packet that includes an
391      * FCS.  If we are ever handed such a packet, either the link-layer
392      * dissector needs to be fixed or the link-layer dissector's preference
393      * needs to be set for your capture (even if that means adding such
394      * a preference).  This dissector (and other dissectors for protcols
395      * running atop the link layer) should not attempt to process the
396      * FCS themselves, as that will just break things. */
397
398     /* Initialize variables */
399     pn_rt_tree = NULL;
400     ti = NULL;
401
402     /*
403      * Set the columns now, so that they'll be set correctly if we throw
404      * an exception.  We can set them (or append things) later again ....
405      */
406
407     col_set_str(pinfo->cinfo, COL_PROTOCOL, "PN-RT");
408     col_set_str(pinfo->cinfo, COL_INFO, "PROFINET Real-Time");
409
410     pdu_len = tvb_reported_length(tvb);
411     if (pdu_len < 6) {
412         dissect_pn_malformed(tvb, 0, pinfo, tree, pdu_len);
413         return;
414     }
415
416     /* build some "raw" data */
417     u16FrameID = tvb_get_ntohs(tvb, 0);
418     if (u16FrameID <= 0x001F) {
419         pszProtShort    = "PN-RT";
420         pszProtAddInfo  = "reserved, ";
421         pszProtSummary  = "Real-Time";
422         pszProtComment  = "0x0000-0x001F: Reserved ID";
423         bCyclic         = FALSE;
424     } else if (u16FrameID <= 0x0021) {
425         pszProtShort    = "PN-PTCP";
426         pszProtAddInfo  = "Synchronization, ";
427         pszProtSummary  = "Real-Time";
428         pszProtComment  = "0x0020-0x0021: Real-Time: Sync (with follow up)";
429         bCyclic         = FALSE;
430     } else if (u16FrameID <= 0x007F) {
431         pszProtShort    = "PN-RT";
432         pszProtAddInfo  = "reserved, ";
433         pszProtSummary  = "Real-Time";
434         pszProtComment  = "0x0022-0x007F: Reserved ID";
435         bCyclic         = FALSE;
436     } else if (u16FrameID <= 0x0081) {
437         pszProtShort    = "PN-PTCP";
438         pszProtAddInfo  = "Synchronization, ";
439         pszProtSummary  = "Isochronous-Real-Time";
440         pszProtComment  = "0x0080-0x0081: Real-Time: Sync (without follow up)";
441         bCyclic         = FALSE;
442     } else if (u16FrameID <= 0x00FF) {
443         pszProtShort    = "PN-RT";
444         pszProtAddInfo  = "reserved, ";
445         pszProtSummary  = "Real-Time";
446         pszProtComment  = "0x0082-0x00FF: Reserved ID";
447         bCyclic         = FALSE;
448
449     } else if (u16FrameID <= 0x6FF) {
450         pszProtShort    = "PN-RTC3";
451         pszProtAddInfo  = "RTC3, ";
452         pszProtSummary  = "Isochronous-Real-Time";
453         pszProtComment  = "0x0100-0x06FF: RED: Real-Time(class=3): non redundant, normal or DFP";
454         bCyclic         = TRUE;
455     } else if (u16FrameID <= 0x0FFF){
456         pszProtShort    = "PN-RTC3";
457         pszProtAddInfo  = "RTC3, ";
458         pszProtSummary  = "Isochronous-Real-Time";
459         pszProtComment  = "0x0700-0x0FFF: RED: Real-Time(class=3): redundant, normal or DFP";
460         bCyclic         = TRUE;
461     } else if (u16FrameID <= 0x7FFF) {
462         pszProtShort    = "PN-RT";
463         pszProtAddInfo  = "reserved, ";
464         pszProtSummary  = "Real-Time";
465         pszProtComment  = "0x1000-0x7FFF: Reserved ID";
466         bCyclic         = FALSE;
467     } else if (u16FrameID <= 0xBBFF){
468         pszProtShort    = "PN-RTC2";
469         pszProtAddInfo  = "RTC2, ";
470         pszProtSummary  = "cyclic Real-Time";
471         pszProtComment  = "0x8000-0xBBFF: Real-Time(class=2): non redundant, normal";
472         bCyclic         = TRUE;
473     } else if (u16FrameID <= 0xBFFF){
474         pszProtShort    = "PN-RTC2";
475         pszProtAddInfo  = "RTC2, ";
476         pszProtSummary  = "cyclic Real-Time";
477         pszProtComment  = "0xBC00-0xBFFF: Real-Time(class=2 multicast): non redundant, normal";
478         bCyclic         = TRUE;
479     } else if (u16FrameID <= 0xF7FF){
480         pszProtShort    = "PN-RTC1/UDP";
481         pszProtAddInfo  = "RTC1/UDP, ";
482         pszProtSummary  = "cyclic Real-Time";
483         pszProtComment  = "0xC000-0xF7FF: Real-Time(class=1/UDP): Cyclic";
484         bCyclic         = TRUE;
485     } else if (u16FrameID <= 0xFBFF){
486         pszProtShort    = "PN-RTC1/UDP";
487         pszProtAddInfo  = "Multicast, ";
488         pszProtSummary  = "cyclic Real-Time";
489         pszProtComment  = "0xF800-0xFBFF: Real-Time(class=1/UDP multicast): Cyclic";
490         bCyclic         = TRUE;
491     } else if (u16FrameID <= 0xFDFF){
492         pszProtShort    = "PN-RTA";
493         pszProtAddInfo  = "Reserved, ";
494         pszProtSummary  = "acyclic Real-Time";
495         pszProtComment  = "0xFC00-0xFDFF: Reserved";
496         bCyclic         = FALSE;
497         if (u16FrameID == 0xfc01) {
498             pszProtShort    = "PN-RTA";
499             pszProtAddInfo  = "Alarm High, ";
500             pszProtSummary  = "acyclic Real-Time";
501             pszProtComment  = "Real-Time: Acyclic PN-IO Alarm high priority";
502         }
503
504     } else if (u16FrameID <= 0xFEFF){
505         pszProtShort    = "PN-RTA";
506         pszProtAddInfo  = "Reserved, ";
507         pszProtSummary  = "acyclic Real-Time";
508         pszProtComment  = "0xFE00-0xFEFF: Real-Time: Reserved";
509         bCyclic         = FALSE;
510         if (u16FrameID == 0xFE01) {
511             pszProtShort    = "PN-RTA";
512             pszProtAddInfo  = "Alarm Low, ";
513             pszProtSummary  = "acyclic Real-Time";
514             pszProtComment  = "Real-Time: Acyclic PN-IO Alarm low priority";
515         }
516         if (u16FrameID == FRAME_ID_DCP_HELLO) {
517             pszProtShort    = "PN-RTA";
518             pszProtAddInfo  = "";
519             pszProtSummary  = "acyclic Real-Time";
520             pszProtComment  = "Real-Time: DCP (Dynamic Configuration Protocol) hello";
521         }
522         if (u16FrameID == FRAME_ID_DCP_GETORSET) {
523             pszProtShort    = "PN-RTA";
524             pszProtAddInfo  = "";
525             pszProtSummary  = "acyclic Real-Time";
526             pszProtComment  = "Real-Time: DCP (Dynamic Configuration Protocol) get/set";
527         }
528         if (u16FrameID == FRAME_ID_DCP_IDENT_REQ) {
529             pszProtShort    = "PN-RTA";
530             pszProtAddInfo  = "";
531             pszProtSummary  = "acyclic Real-Time";
532             pszProtComment  = "Real-Time: DCP (Dynamic Configuration Protocol) identify multicast request";
533         }
534         if (u16FrameID == FRAME_ID_DCP_IDENT_RES) {
535             pszProtShort    = "PN-RTA";
536             pszProtAddInfo  = "";
537             pszProtSummary  = "acyclic Real-Time";
538             pszProtComment  = "Real-Time: DCP (Dynamic Configuration Protocol) identify response";
539         }
540     } else if (u16FrameID <= 0xFF01){
541         pszProtShort    = "PN-PTCP";
542         pszProtAddInfo  = "RTA Sync, ";
543         pszProtSummary  = "acyclic Real-Time";
544         pszProtComment  = "0xFF00-0xFF01: PTCP Announce";
545         bCyclic         = FALSE;
546     } else if (u16FrameID <= 0xFF1F){
547         pszProtShort    = "PN-PTCP";
548         pszProtAddInfo  = "RTA Sync, ";
549         pszProtSummary  = "acyclic Real-Time";
550         pszProtComment  = "0xFF02-0xFF1F: Reserved";
551         bCyclic         = FALSE;
552     } else if (u16FrameID <= 0xFF21){
553         pszProtShort    = "PN-PTCP";
554         pszProtAddInfo  = "Follow Up, ";
555         pszProtSummary  = "acyclic Real-Time";
556         pszProtComment  = "0xFF20-0xFF21: PTCP Follow Up";
557         bCyclic         = FALSE;
558     } else if (u16FrameID <= 0xFF22){
559         pszProtShort    = "PN-PTCP";
560         pszProtAddInfo  = "Follow Up, ";
561         pszProtSummary  = "acyclic Real-Time";
562         pszProtComment  = "0xFF22-0xFF3F: Reserved";
563         bCyclic         = FALSE;
564     } else if (u16FrameID <= 0xFF43){
565         pszProtShort    = "PN-PTCP";
566         pszProtAddInfo  = "Delay, ";
567         pszProtSummary  = "acyclic Real-Time";
568         pszProtComment  = "0xFF40-0xFF43: Acyclic Real-Time: Delay";
569         bCyclic         = FALSE;
570     } else if (u16FrameID <= 0xFF7F){
571         pszProtShort    = "PN-RT";
572         pszProtAddInfo  = "Reserved, ";
573         pszProtSummary  = "Real-Time";
574         pszProtComment  = "0xFF44-0xFF7F: reserved ID";
575         bCyclic         = FALSE;
576     } else if (u16FrameID <= 0xFF8F){
577         pszProtShort    = "PN-RT";
578         pszProtAddInfo  = "Fragmentation, ";
579         pszProtSummary  = "Real-Time";
580         pszProtComment  = "0xFF80-0xFF8F: Fragmentation";
581         bCyclic         = FALSE;
582     } else {
583         pszProtShort    = "PN-RT";
584         pszProtAddInfo  = "Reserved, ";
585         pszProtSummary  = "Real-Time";
586         pszProtComment  = "0xFF90-0xFFFF: reserved ID";
587         bCyclic         = FALSE;
588     }
589
590     /* decode optional cyclic fields at the packet end and build the summary line */
591     if (bCyclic) {
592         /* cyclic transfer has cycle counter, data status and transfer status fields at the end */
593         u16CycleCounter = tvb_get_ntohs(tvb, pdu_len - 4);
594         u8DataStatus = tvb_get_guint8(tvb, pdu_len - 2);
595         u8TransferStatus = tvb_get_guint8(tvb, pdu_len - 1);
596
597         g_snprintf (szFieldSummary, sizeof(szFieldSummary),
598                   "%sID:0x%04x, Len:%4u, Cycle:%5u (%s,%s,%s,%s)",
599                 pszProtAddInfo, u16FrameID, pdu_len - 2 - 4, u16CycleCounter,
600                 (u8DataStatus & 0x04) ? "Valid" : "Invalid",
601                 (u8DataStatus & 0x01) ? "Primary" : "Backup",
602                 (u8DataStatus & 0x20) ? "Ok" : "Problem",
603                 (u8DataStatus & 0x10) ? "Run" : "Stop");
604
605         /* user data length is packet len - frame id - optional cyclic status fields */
606         data_len = pdu_len - 2 - 4;
607     } else {
608         /* satisfy the gcc compiler, so it won't throw an "uninitialized" warning */
609         u16CycleCounter     = 0;
610         u8DataStatus        = 0;
611         u8TransferStatus    = 0;
612
613         /* acyclic transfer has no fields at the end */
614         g_snprintf (szFieldSummary, sizeof(szFieldSummary),
615                   "%sID:0x%04x, Len:%4u",
616                 pszProtAddInfo, u16FrameID, pdu_len - 2);
617
618         /* user data length is packet len - frame id field */
619         data_len = pdu_len - 2;
620     }
621
622     /* build protocol tree only, if tree is really used */
623     if (tree) {
624         /* build pn_rt protocol tree with summary line */
625         if (pn_rt_summary_in_tree) {
626           ti = proto_tree_add_protocol_format(tree, proto_pn_rt, tvb, 0, pdu_len,
627                 "PROFINET %s, %s", pszProtSummary, szFieldSummary);
628         } else {
629             ti = proto_tree_add_item(tree, proto_pn_rt, tvb, 0, pdu_len, ENC_NA);
630         }
631         pn_rt_tree = proto_item_add_subtree(ti, ett_pn_rt);
632
633         /* add frame ID */
634         proto_tree_add_uint_format(pn_rt_tree, hf_pn_rt_frame_id, tvb,
635           0, 2, u16FrameID, "FrameID: 0x%04x (%s)", u16FrameID, pszProtComment);
636
637         if (bCyclic) {
638             /* add cycle counter */
639             proto_tree_add_uint_format(pn_rt_tree, hf_pn_rt_cycle_counter, tvb,
640               pdu_len - 4, 2, u16CycleCounter, "CycleCounter: %u", u16CycleCounter);
641
642             /* add data status subtree */
643             dissect_DataStatus(tvb, pdu_len - 2, tree, u8DataStatus);
644
645             /* add transfer status */
646             if (u8TransferStatus) {
647                 proto_tree_add_uint_format(pn_rt_tree, hf_pn_rt_transfer_status, tvb,
648                     pdu_len - 1, 1, u8TransferStatus,
649                     "TransferStatus: 0x%02x (ignore this frame)", u8TransferStatus);
650             } else {
651                 proto_tree_add_uint_format(pn_rt_tree, hf_pn_rt_transfer_status, tvb,
652                     pdu_len - 1, 1, u8TransferStatus,
653                     "TransferStatus: 0x%02x (OK)", u8TransferStatus);
654             }
655         }
656     }
657
658     /* update column info now */
659     col_add_str(pinfo->cinfo, COL_INFO, szFieldSummary);
660     col_set_str(pinfo->cinfo, COL_PROTOCOL, pszProtShort);
661
662     pinfo->private_data = GUINT_TO_POINTER( (guint32) u16FrameID);
663
664     /* get frame user data tvb (without header and footer) */
665     next_tvb = tvb_new_subset(tvb, 2, data_len, data_len);
666
667     /* ask heuristics, if some sub-dissector is interested in this packet payload */
668     if(!dissector_try_heuristic(heur_subdissector_list, next_tvb, pinfo, tree)) {
669         /*col_set_str(pinfo->cinfo, COL_INFO, "Unknown");*/
670
671         /* Oh, well, we don't know this; dissect it as data. */
672         dissect_pn_undecoded(next_tvb, 0, pinfo, tree, tvb_length(next_tvb));
673     }
674 }
675
676
677 /* Register all the bits needed by the filtering engine */
678 void
679 proto_register_pn_rt(void)
680 {
681   static hf_register_info hf[] = {
682     { &hf_pn_rt_frame_id, {
683       "FrameID", "pn_rt.frame_id", FT_UINT16, BASE_DEC, NULL, 0x0, NULL, HFILL }},
684     { &hf_pn_rt_cycle_counter, {
685         "CycleCounter", "pn_rt.cycle_counter", FT_UINT16, BASE_DEC, NULL, 0x0, NULL, HFILL }},
686     { &hf_pn_rt_data_status, {
687         "DataStatus", "pn_rt.ds", FT_UINT8, BASE_HEX, 0, 0x0, NULL, HFILL }},
688     { &hf_pn_rt_data_status_ignore, {
689         "Ignore (1:Ignore/0:Evaluate)", "pn_rt.ds_ignore", FT_UINT8, BASE_HEX, 0, 0x80, NULL, HFILL }},
690     { &hf_pn_rt_data_status_Reserved_2, {
691         "Reserved_2 (should be zero)", "pn_rt.ds_Reserved_2", FT_UINT8, BASE_HEX, 0, 0x40, NULL, HFILL }},
692     { &hf_pn_rt_data_status_ok, {
693         "StationProblemIndicator (1:Ok/0:Problem)", "pn_rt.ds_ok", FT_UINT8, BASE_HEX, 0, 0x20, NULL, HFILL }},
694     { &hf_pn_rt_data_status_operate, {
695         "ProviderState (1:Run/0:Stop)", "pn_rt.ds_operate", FT_UINT8, BASE_HEX, 0, 0x10, NULL, HFILL }},
696     { &hf_pn_rt_data_status_res3, {
697         "Reserved_1 (should be zero)", "pn_rt.ds_res3", FT_UINT8, BASE_HEX, 0, 0x08, NULL, HFILL }},
698     { &hf_pn_rt_data_status_valid, {
699         "DataValid (1:Valid/0:Invalid)", "pn_rt.ds_valid", FT_UINT8, BASE_HEX, 0, 0x04, NULL, HFILL }},
700     { &hf_pn_rt_data_status_redundancy, { 
701         "Redundancy", "pn_rt.ds_redundancy", FT_UINT8, BASE_HEX, VALS(pn_rt_ds_redundancy), 0x02, NULL, HFILL }},
702     { &hf_pn_rt_data_status_primary, {
703         "State (1:Primary/0:Backup)", "pn_rt.ds_primary", FT_UINT8, BASE_HEX, 0, 0x01, NULL, HFILL }},
704     { &hf_pn_rt_transfer_status,
705       { "TransferStatus", "pn_rt.transfer_status", FT_UINT8, BASE_DEC, NULL, 0x0, NULL, HFILL }},
706     { &hf_pn_rt_sf, {
707         "SubFrame", "pn_rt.sf", FT_NONE, BASE_NONE, NULL, 0x0, NULL, HFILL }},
708     { &hf_pn_rt_sf_crc16, {
709         "SFCRC16", "pn_rt.sf.crc16", FT_UINT16, BASE_HEX, NULL, 0x0, NULL, HFILL }},
710     { &hf_pn_rt_sf_position, {
711         "Position", "pn_rt.sf.position", FT_UINT8, BASE_DEC, NULL, 0x7F, NULL, HFILL }},
712     { &hf_pn_rt_sf_position_control, {
713         "Control", "pn_rt.sf.position_control", FT_UINT8, BASE_DEC, VALS(pn_rt_position_control), 0x80, NULL, HFILL }},
714     { &hf_pn_rt_sf_data_length, {
715         "DataLength", "pn_rt.sf.data_length", FT_UINT8, BASE_DEC, NULL, 0x0, NULL, HFILL }},
716     { &hf_pn_rt_sf_cycle_counter, {
717         "CycleCounter", "pn_rt.sf.cycle_counter", FT_UINT8, BASE_DEC, NULL, 0x0, NULL, HFILL }},
718     { &hf_pn_rt_frag, {
719         "PROFINET Real-Time Fragment", "pn_rt.frag", FT_NONE, BASE_NONE, NULL, 0x0, NULL, HFILL }},
720     { &hf_pn_rt_frag_data_length, {
721         "FragDataLength", "pn_rt.frag_data_length", FT_UINT8, BASE_DEC, NULL, 0x0, NULL, HFILL }},
722     { &hf_pn_rt_frag_status, {
723         "FragStatus", "pn_rt.frag_status", FT_NONE, BASE_NONE, NULL, 0x0, NULL, HFILL }},
724     { &hf_pn_rt_frag_status_more_follows, {
725         "MoreFollows", "pn_rt.frag_status.more_follows", FT_UINT8, BASE_HEX, VALS(pn_rt_frag_status_more_follows), 0x80, NULL, HFILL }},
726     { &hf_pn_rt_frag_status_error, {
727         "Error", "pn_rt.frag_status.error", FT_UINT8, BASE_HEX, VALS(pn_rt_frag_status_error), 0x40, NULL, HFILL }},
728     { &hf_pn_rt_frag_status_fragment_number, {
729         "FragmentNumber (zero based)", "pn_rt.frag_status.fragment_number", FT_UINT8, BASE_DEC, NULL, 0x3F, NULL, HFILL }},
730     { &hf_pn_rt_frag_data, {
731         "FragData", "pn_rt.frag_data", FT_NONE, BASE_NONE, NULL, 0x00, NULL, HFILL }},
732   };
733   static gint *ett[] = {
734     &ett_pn_rt,
735     &ett_pn_rt_data_status,
736     &ett_pn_rt_sf,
737     &ett_pn_rt_frag,
738     &ett_pn_rt_frag_status
739   };
740   module_t *pn_rt_module;
741
742   proto_pn_rt = proto_register_protocol("PROFINET Real-Time Protocol",
743                        "PN-RT", "pn_rt");
744
745   proto_register_field_array(proto_pn_rt, hf, array_length(hf));
746   proto_register_subtree_array(ett, array_length(ett));
747
748   /* Register our configuration options */
749
750   pn_rt_module = prefs_register_protocol(proto_pn_rt, NULL);
751
752   prefs_register_bool_preference(pn_rt_module, "summary_in_tree",
753         "Show PN-RT summary in protocol tree",
754         "Whether the PN-RT summary line should be shown in the protocol tree",
755         &pn_rt_summary_in_tree);
756
757   /* register heuristics anchor for payload dissectors */
758   register_heur_dissector_list("pn_rt", &heur_subdissector_list);
759
760   init_pn (proto_pn_rt);
761 }
762
763
764 /* The registration hand-off routine is called at startup */
765 void
766 proto_reg_handoff_pn_rt(void)
767 {
768   dissector_handle_t pn_rt_handle;
769
770   pn_rt_handle = create_dissector_handle(dissect_pn_rt, proto_pn_rt);
771
772   dissector_add_uint("ethertype", ETHERTYPE_PROFINET, pn_rt_handle);
773   dissector_add_uint("udp.port", 0x8892, pn_rt_handle);
774
775   heur_dissector_add("pn_rt", dissect_CSF_SDU_heur, proto_pn_rt);
776   heur_dissector_add("pn_rt", dissect_FRAG_PDU_heur, proto_pn_rt);
777 }
778