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