Removed trailing whitespaces from .h and .c files using the
[obnox/wireshark/wip.git] / packet-lmi.c
1 /* packet-lmi.c
2  * Routines for Frame Relay Local Management Interface (LMI) disassembly
3  * Copyright 2001, Jeffrey C. Foster <jfoste@woodward.com>
4  *
5  * $Id: packet-lmi.c,v 1.10 2002/08/02 23:35:54 jmayer Exp $
6  *
7  * Ethereal - Network traffic analyzer
8  * By Gerald Combs <gerald@ethereal.com>
9  * Copyright 1998
10  * 
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  * 
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  * 
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * ToDo:
26  *
27  * References:
28  *
29  * http://www.techfest.com/networking/wan/frrel.htm
30  * http://www.frforum.com/5000/frf1_2.pdf
31  * http://www.cisco.com/univercd/cc/td/doc/cisintwk/ito_doc/frame.htm#xtocid125314
32  * http://www.net.aapt.com.au/techref/lmimess.htm
33  * http://www.raleigh.ibm.com:80/cgi-bin/bookmgr/BOOKS/EZ305800/1.2.4.4
34  */
35
36
37 #ifdef HAVE_CONFIG_H
38 # include "config.h"
39 #endif
40
41 #include <stdio.h>
42 #include <glib.h>
43 #include <string.h>
44 #include <epan/packet.h>
45 #include "nlpid.h"
46
47 static int proto_lmi = -1;
48 static int hf_lmi_call_ref = -1;
49 static int hf_lmi_msg_type = -1;
50 static int hf_lmi_inf_ele = -1;
51 static int hf_lmi_inf_len = -1;
52                         
53 static int hf_lmi_rcd_type = -1;
54 static int hf_lmi_send_seq = -1;
55 static int hf_lmi_recv_seq = -1;
56 static int hf_lmi_dlci_high = -1;
57 static int hf_lmi_dlci_low = -1;
58 static int hf_lmi_new = -1;
59 static int hf_lmi_act = -1;
60
61 static gint ett_lmi = -1;
62 static gint ett_lmi_ele = -1;
63
64 #ifdef _OLD_
65 /*
66  * Bits in the address field.
67  */
68 #define LMI_CMD         0xf000  /* LMI Command */
69 #define LMI_SEQ         0x0fff  /* LMI Sequence number */
70
71 #endif
72
73 static const value_string msg_type_str[] = {
74         {0x75, "Status Enquiry"},
75         {0x7D, "Status"},
76         { 0,       NULL }
77         };
78
79 static const value_string element_type_str[] = {
80
81 /*** These are the ANSI values ***/
82         {0x01, "Report"},
83         {0x03, "Keep Alive"},
84         {0x07, "PVC Status"},
85
86 /*** These are the ITU values ***/
87         {0x51, "Report"},
88         {0x53, "Keep Alive"},
89         {0x07, "PVC Status"},
90
91         { 0,       NULL }
92         };
93
94 static const value_string record_type_str[] = {
95         {0x00, "Full Status"},
96         {0x01, "Link Integrity Verification Only"},
97         {0x02, "Single PVC"},
98         { 0,       NULL }
99         };
100
101 static const value_string pvc_status_new_str[] = {
102         {0x00, "PVC already present"},
103         {0x01, "PVC is new"},
104         { 0,       NULL }
105         };
106
107 static const value_string pvc_status_act_str[] = {
108         {0x00, "PVC is Inactive"},
109         {0x01, "PVC is Active"},
110         { 0,       NULL }
111         };
112
113 static void
114 dissect_lmi_report_type(tvbuff_t *tvb, int offset, proto_tree *tree)
115 {
116         proto_tree_add_uint(tree, hf_lmi_rcd_type, tvb, offset, 1, tvb_get_guint8( tvb, offset));
117 }
118
119 static void
120 dissect_lmi_link_int(tvbuff_t *tvb, int offset, proto_tree *tree)
121 {
122         proto_tree_add_uint(tree, hf_lmi_send_seq, tvb, offset, 1, tvb_get_guint8( tvb, offset));
123         ++offset;
124         proto_tree_add_uint(tree, hf_lmi_recv_seq, tvb, offset, 1, tvb_get_guint8( tvb, offset));
125
126 }
127
128 static void
129 dissect_lmi_pvc_status(tvbuff_t *tvb, int offset, proto_tree *tree)
130 {
131         proto_tree_add_uint(tree, hf_lmi_dlci_high, tvb, offset, 1, tvb_get_guint8( tvb, offset));
132         ++offset;
133         proto_tree_add_uint(tree, hf_lmi_dlci_low, tvb, offset, 1, tvb_get_guint8( tvb, offset));
134         ++offset;
135         proto_tree_add_uint(tree, hf_lmi_new, tvb, offset, 1, tvb_get_guint8( tvb, offset));
136         proto_tree_add_uint(tree, hf_lmi_act, tvb, offset, 1, tvb_get_guint8( tvb, offset));
137 }
138
139 static void
140 dissect_lmi(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
141 {
142         proto_tree      *lmi_tree, *lmi_subtree;
143         proto_item      *ti;
144         int             offset = 2, len;
145         guint8          ele_id;
146
147         if (check_col(pinfo->cinfo, COL_PROTOCOL))
148                 col_set_str(pinfo->cinfo, COL_PROTOCOL, "LMI");
149
150         if (tree) {
151                 ti = proto_tree_add_item(tree, proto_lmi, tvb, 0, 3, FALSE);
152                 lmi_tree = proto_item_add_subtree(ti, ett_lmi_ele);
153
154                 proto_tree_add_uint(lmi_tree, hf_lmi_call_ref, tvb, 0, 1, tvb_get_guint8( tvb, 0));
155                 proto_tree_add_uint(lmi_tree, hf_lmi_msg_type,  tvb, 1, 1,  tvb_get_guint8( tvb, 1));
156
157         /* Display the LMI elements */
158                 while (tvb_reported_length_remaining(tvb, offset) > 0) {
159                         ele_id = tvb_get_guint8( tvb, offset);
160                         len =  tvb_get_guint8( tvb, offset + 1);
161
162                         ti = proto_tree_add_uint(lmi_tree, hf_lmi_inf_ele, tvb, offset, len + 2, 
163                                 tvb_get_guint8( tvb, offset));
164
165                         lmi_subtree = proto_item_add_subtree(ti, ett_lmi_ele);
166
167                         proto_tree_add_uint(lmi_subtree, hf_lmi_inf_ele, tvb, offset, 1,
168                                 tvb_get_guint8( tvb, offset));
169                         ++offset;
170                         len =  tvb_get_guint8( tvb, offset);
171                         proto_tree_add_uint(lmi_subtree, hf_lmi_inf_len, tvb, offset, 1, len);
172                         ++offset;
173                         if (( ele_id == 1) || (ele_id == 51))   
174                                 dissect_lmi_report_type( tvb, offset, lmi_subtree);
175                         else if (( ele_id == 3) || (ele_id == 53))      
176                                 dissect_lmi_link_int( tvb, offset, lmi_subtree);
177                         else if (( ele_id == 7) || (ele_id == 57))      
178                                 dissect_lmi_pvc_status( tvb, offset, lmi_subtree);
179                         offset += len;
180                 }       
181         }
182         else {
183                 lmi_tree = NULL;
184         }
185 }
186
187
188 void
189 proto_register_lmi(void)
190 {
191     static hf_register_info hf[] = {
192         { &hf_lmi_call_ref,
193           { "Call reference", "lmi.cmd", FT_UINT8, BASE_HEX, NULL, 0, 
194                 "Call Reference", HFILL }},
195
196         { &hf_lmi_msg_type,
197           { "Message Type", "lmi.msg_type", FT_UINT8, BASE_HEX, VALS(msg_type_str), 0, 
198                 "Message Type", HFILL }},
199
200         { &hf_lmi_inf_ele,
201           { "Information Element", "lmi.inf_ele", FT_UINT8, BASE_DEC, VALS(element_type_str), 0,
202                 "Information Element", HFILL }},
203         { &hf_lmi_inf_ele,
204           { "Type", "lmi.inf_ele_type", FT_UINT8, BASE_DEC, VALS(element_type_str), 0,
205                 "Information Element Type", HFILL }},
206         { &hf_lmi_inf_len,
207           { "Length", "lmi.inf_ele_len", FT_UINT8, BASE_DEC, NULL, 0,
208                 "Information Element Length", HFILL }},
209
210         { &hf_lmi_rcd_type,
211           { "Record Type", "lmi.ele_rcd_type", FT_UINT8, BASE_DEC, VALS(record_type_str), 0,
212                 "Record Type", HFILL }},
213         { &hf_lmi_send_seq,
214           { "Send Seq", "lmi.send_seq", FT_UINT8, BASE_DEC, NULL, 0,
215                 "Send Sequence", HFILL }},
216         { &hf_lmi_recv_seq,
217           { "Recv Seq", "lmi.recv_seq", FT_UINT8, BASE_DEC, NULL, 0,
218                 "Receive Sequence", HFILL }},
219         { &hf_lmi_dlci_high,
220           { "DLCI High", "lmi.dlci_hi", FT_UINT8, BASE_DEC, NULL, 0x3f,
221                 "DLCI High bits", HFILL }},
222         { &hf_lmi_dlci_low,
223           { "DLCI Low", "lmi.dlci_low", FT_UINT8, BASE_DEC, NULL, 0x78,
224                 "DLCI Low bits", HFILL }},
225         { &hf_lmi_new,
226           { "DLCI New", "lmi.dlci_new", FT_UINT8, BASE_DEC, VALS(pvc_status_new_str), 0x08,
227                 "DLCI New Flag", HFILL }},
228         { &hf_lmi_act,
229           { "DLCI Active","lmi.dlci_act", FT_UINT8, BASE_DEC, VALS(pvc_status_act_str), 0x02,
230                 "DLCI Active Flag", HFILL }},
231     };
232     static gint *ett[] = {
233         &ett_lmi,
234         &ett_lmi_ele,
235     };
236     proto_lmi = proto_register_protocol ("Local Management Interface", "LMI", "lmi");
237     proto_register_field_array (proto_lmi, hf, array_length(hf));
238     proto_register_subtree_array(ett, array_length(ett));
239
240 }
241
242 void
243 proto_reg_handoff_lmi(void)
244 {
245         dissector_handle_t lmi_handle;
246
247         lmi_handle = create_dissector_handle(dissect_lmi, proto_lmi);
248         dissector_add("fr.ietf", NLPID_LMI, lmi_handle);
249 }