Man page for dahdi_maint
[dahdi/tools.git] / dahdi_maint.c
1 /*
2  * Performance and Maintenance utility
3  *
4  * Written by Russ Meyerriecks <rmeyerriecks@digium.com>
5  *
6  * Copyright (C) 2009-2010 Digium, Inc.
7  *
8  * All rights reserved.
9  *
10  */
11
12 /*
13  * See http://www.asterisk.org for more information about
14  * the Asterisk project. Please do not directly contact
15  * any of the maintainers of this project for assistance;
16  * the project provides a web site, mailing lists and IRC
17  * channels for your use.
18  *
19  * This program is free software, distributed under the terms of
20  * the GNU General Public License Version 2 as published by the
21  * Free Software Foundation. See the LICENSE file included with
22  * this program for more details.
23  */
24
25 #include <stdio.h>
26 #include <getopt.h>
27 #include <unistd.h>
28 #include <string.h>
29 #include <errno.h>
30 #include <sys/ioctl.h>
31 #include <fcntl.h>
32 #include <stdlib.h>
33
34 #include <dahdi/user.h>
35 #include "dahdi_tools_version.h"
36
37 #define DAHDI_CTL "/dev/dahdi/ctl"
38
39 extern char *optarg;
40 extern int optind;
41
42 void display_help(char *argv0, int exitcode)
43 {
44         char *c;
45         c = strrchr(argv0, '/');
46         if (!c)
47                 c = argv0;
48         else
49                 c++;
50         fprintf(stderr, "%s\n\n", dahdi_tools_version);
51         fprintf(stderr, "Usage: %s -s <span num> <options>\n", c);
52         fprintf(stderr, "Options:\n");
53         fprintf(stderr, "        -h, --help             display help\n");
54         fprintf(stderr, "        -s, --span <span num>  specify the span\n");
55         fprintf(stderr, "        -l, --loopback <localhost|networkline|"\
56                                                 "networkpayload|loopup|"\
57                                                 "loopdown|off>\n"\
58                         "\t\tlocalhost - loop back towards host\n"\
59                         "\t\tnetworkline - network line loopback\n"\
60                         "\t\tnetworkpayload - network payload loopback\n"\
61                         "\t\tloopup - transmit loopup signal\n"\
62                         "\t\tloopdown - transmit loopdown signal\n"\
63                         "\t\toff - end loopback mode\n");
64         fprintf(stderr, "        -i, --insert <fas|multi|crc|cas|prbs|bipolar>"\
65                         "\n\t\tinsert an error of a specific type\n");
66         fprintf(stderr, "        -r, --reset            "\
67                         "reset the error counters\n\n");
68         fprintf(stderr, "Examples: \n");
69         fprintf(stderr, "Enable network line loopback\n");
70         fprintf(stderr, "       dahdi_maint -s 1 --loopback networkline\n");
71         fprintf(stderr, "Disable network line loopback\n");
72         fprintf(stderr, "       dahdi_maint -s 1 --loopback off\n\n");
73
74         exit(exitcode);
75 }
76
77 int main(int argc, char *argv[])
78 {
79         static int ctl = -1;
80         int res;
81
82         int doloopback = 0;
83         char *larg = NULL;
84         int sflag = 0;
85         int span = 1;
86         int iflag = 0;
87         char *iarg = NULL;
88         int gflag = 0;
89         int c;
90         int rflag = 0;
91
92         struct dahdi_maintinfo m;
93         struct dahdi_spaninfo s;
94
95         static struct option long_options[] = {
96                 {"help",        no_argument,       0, 'h'},
97                 {"loopback",    required_argument, 0, 'l'},
98                 {"span",        required_argument, 0, 's'},
99                 {"insert",      required_argument, 0, 'i'},
100                 {"reset",       no_argument,       0, 'r'},
101                 {0, 0, 0, 0}
102         };
103         int option_index = 0;
104
105         if (argc < 2) { /* no options */
106                 display_help(argv[0], 1);
107         }
108
109         while ((c = getopt_long(argc, argv, "hj:l:p:s:i:g:r",
110                                 long_options, &option_index)) != -1) {
111                         switch (c) {
112                         case 'h':
113                                 display_help(argv[0], 0);
114                                 break;
115                         case 'l': /* loopback */
116                                 larg = optarg;
117                                 doloopback = 1;
118                                 break;
119                         case 's': /* specify a span */
120                                 span = atoi(optarg);
121                                 sflag = 1;
122                                 break;
123                         case 'i': /* insert an error */
124                                 iarg = optarg;
125                                 iflag = 1;
126                                 break;
127                         case 'g': /* generate psuedo random sequence */
128                                 gflag = 1;
129                                 break;
130                         case 'r': /* reset the error counters */
131                                 rflag = 1;
132                                 break;
133                         }
134         }
135
136         ctl = open(DAHDI_CTL, O_RDWR);
137         if (ctl < 0) {
138                 fprintf(stderr, "Unable to open %s\n", DAHDI_CTL);
139                 return -1;
140         }
141
142         if (!(doloopback || iflag || gflag || rflag)) {
143                 s.spanno = span;
144                 res = ioctl(ctl, DAHDI_SPANSTAT, &s);
145                 if (res)
146                         printf("Error counters not supported by the driver"\
147                                         " for this span\n");
148                 printf("Span %d:\n", span);
149                 printf(">Framing Errors : %d:\n", s.fecount);
150                 printf(">CRC Errors : %d:\n", s.crc4count);
151                 printf(">Code Violations : %d:\n", s.cvcount);
152                 printf(">E-bit Count : %d:\n", s.ebitcount);
153                 printf(">General Errored Seconds : %d:\n", s.errsec);
154
155                 return 0;
156         }
157
158         m.spanno = span;
159
160         if (doloopback) {
161                 if (!strcasecmp(larg, "localhost")) {
162                         printf("Span %d: local host loopback ON\n", span);
163                         m.command = DAHDI_MAINT_LOCALLOOP;
164                 } else if (!strcasecmp(larg, "networkline")) {
165                         printf("Span %d: network line loopback ON\n", span);
166                         m.command = DAHDI_MAINT_NETWORKLINELOOP;
167                 } else if (!strcasecmp(larg, "networkpayload")) {
168                         printf("Span %d: network payload loopback ON\n", span);
169                         m.command = DAHDI_MAINT_NETWORKPAYLOADLOOP;
170                 } else if (!strcasecmp(larg, "loopup")) {
171                         printf("Span %d: transmitting loopup signal\n", span);
172                         m.command = DAHDI_MAINT_LOOPUP;
173                 } else if (!strcasecmp(larg, "loopdown")) {
174                         printf("Span %d: transmitting loopdown signal\n", span);
175                         m.command = DAHDI_MAINT_LOOPDOWN;
176                 } else if (!strcasecmp(larg, "off")) {
177                         printf("Span %d: loopback OFF\n", span);
178                         m.command = DAHDI_MAINT_NONE;
179                 } else {
180                         display_help(argv[0], 1);
181                 }
182
183                 res = ioctl(ctl, DAHDI_MAINT, &m);
184                 if (res) {
185                         printf("This type of looping not supported by the"\
186                                         " driver for this span\n");
187                         return 1;
188                 }
189
190                 /* Leave the loopup/loopdown signal on the line for
191                  * five seconds according to AT&T TR 54016
192                  */
193                 if ((m.command == DAHDI_MAINT_LOOPUP) ||
194                    (m.command == DAHDI_MAINT_LOOPDOWN)) {
195                         sleep(5);
196                         m.command = DAHDI_MAINT_NONE;
197                         ioctl(ctl, DAHDI_MAINT, &m);
198                 }
199         }
200
201         if (iflag) {
202                 if (!strcasecmp(iarg, "fas")) {
203                         m.command = DAHDI_MAINT_FAS_DEFECT;
204                         printf("Inserting a single FAS defect\n");
205                 } else if (!strcasecmp(iarg, "multi")) {
206                         m.command = DAHDI_MAINT_MULTI_DEFECT;
207                         printf("Inserting a single multiframe defect\n");
208                 } else if (!strcasecmp(iarg, "crc")) {
209                         m.command = DAHDI_MAINT_CRC_DEFECT;
210                         printf("Inserting a single CRC defect\n");
211                 } else if (!strcasecmp(iarg, "cas")) {
212                         m.command = DAHDI_MAINT_CAS_DEFECT;
213                         printf("Inserting a single CAS defect\n");
214                 } else if (!strcasecmp(iarg, "prbs")) {
215                         m.command = DAHDI_MAINT_PRBS_DEFECT;
216                         printf("Inserting a single PRBS defect\n");
217                 } else if (!strcasecmp(iarg, "bipolar")) {
218                         m.command = DAHDI_MAINT_BIPOLAR_DEFECT;
219                         printf("Inserting a single bipolar defect\n");
220 #ifdef DAHDI_MAINT_ALARM_SIM
221                 } else if (!strcasecmp(iarg, "sim")) {
222                         m.command = DAHDI_MAINT_ALARM_SIM;
223                         printf("Incrementing alarm simulator\n");
224 #endif
225                 } else {
226                         display_help(argv[0], 1);
227                 }
228                 res = ioctl(ctl, DAHDI_MAINT, &m);
229                 if (res)
230                         printf("This type of error injection is not supported"\
231                                         " by the driver for this span\n");
232         }
233
234         if (gflag) {
235                 printf("Enabled the Pseudo-Random Binary Sequence Generation"\
236                         " and Monitor\n");
237                 m.command = DAHDI_MAINT_PRBS;
238                 res = ioctl(ctl, DAHDI_MAINT, &m);
239                 if (res) {
240                         printf("Pseudo-random binary sequence generation is"\
241                                 " not supported by the driver for this span\n");
242                 }
243         }
244
245         if (rflag) {
246                 printf("Resetting error counters for span %d\n", span);
247                 m.command = DAHDI_RESET_COUNTERS;
248                 res = ioctl(ctl, DAHDI_MAINT, &m);
249                 if (res) {
250                         printf("Resetting error counters is not supported by"\
251                                         " the driver for this span\n");
252                 }
253         }
254
255         return 0;
256 }