Merged revisions 328247 via svnmerge from
[asterisk/asterisk.git] / res / res_timing_dahdi.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2008, Digium, Inc.
5  *
6  * Russell Bryant <russell@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! 
20  * \file
21  * \author Russell Bryant <russell@digium.com>
22  *
23  * \brief DAHDI timing interface 
24  */
25
26 /*** MODULEINFO
27         <depend>dahdi</depend>
28         <support_level>core</support_level>
29  ***/
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$");
34
35 #include <sys/types.h>
36 #include <sys/stat.h>
37 #include <fcntl.h>
38 #include <math.h>
39
40 #include <dahdi/user.h>
41
42 #include "asterisk/module.h"
43 #include "asterisk/timing.h"
44 #include "asterisk/utils.h"
45
46 static void *timing_funcs_handle;
47
48 static int dahdi_timer_open(void);
49 static void dahdi_timer_close(int handle);
50 static int dahdi_timer_set_rate(int handle, unsigned int rate);
51 static void dahdi_timer_ack(int handle, unsigned int quantity);
52 static int dahdi_timer_enable_continuous(int handle);
53 static int dahdi_timer_disable_continuous(int handle);
54 static enum ast_timer_event dahdi_timer_get_event(int handle);
55 static unsigned int dahdi_timer_get_max_rate(int handle);
56
57 static struct ast_timing_interface dahdi_timing = {
58         .name = "DAHDI",
59         .priority = 100,
60         .timer_open = dahdi_timer_open,
61         .timer_close = dahdi_timer_close,
62         .timer_set_rate = dahdi_timer_set_rate,
63         .timer_ack = dahdi_timer_ack,
64         .timer_enable_continuous = dahdi_timer_enable_continuous,
65         .timer_disable_continuous = dahdi_timer_disable_continuous,
66         .timer_get_event = dahdi_timer_get_event,
67         .timer_get_max_rate = dahdi_timer_get_max_rate,
68 };
69
70 static int dahdi_timer_open(void)
71 {
72         return open("/dev/dahdi/timer", O_RDWR);
73 }
74
75 static void dahdi_timer_close(int handle)
76 {
77         close(handle);
78 }
79
80 static int dahdi_timer_set_rate(int handle, unsigned int rate)
81 {
82         int samples;
83
84         /* DAHDI timers are configured using a number of samples,
85          * based on an 8 kHz sample rate. */
86         samples = (unsigned int) roundf((8000.0 / ((float) rate)));
87
88         if (ioctl(handle, DAHDI_TIMERCONFIG, &samples)) {
89                 ast_log(LOG_ERROR, "Failed to configure DAHDI timing fd for %u sample timer ticks\n",
90                         samples);
91                 return -1;
92         }
93
94         return 0;
95 }
96
97 static void dahdi_timer_ack(int handle, unsigned int quantity)
98 {
99         ioctl(handle, DAHDI_TIMERACK, &quantity);
100 }
101
102 static int dahdi_timer_enable_continuous(int handle)
103 {
104         int flags = 1;
105
106         return ioctl(handle, DAHDI_TIMERPING, &flags) ? -1 : 0;
107 }
108
109 static int dahdi_timer_disable_continuous(int handle)
110 {
111         int flags = -1;
112
113         return ioctl(handle, DAHDI_TIMERPONG, &flags) ? -1 : 0;
114 }
115
116 static enum ast_timer_event dahdi_timer_get_event(int handle)
117 {
118         int res;
119         int event;
120
121         res = ioctl(handle, DAHDI_GETEVENT, &event);
122
123         if (res) {
124                 event = DAHDI_EVENT_TIMER_EXPIRED;
125         }
126
127         switch (event) {
128         case DAHDI_EVENT_TIMER_PING:
129                 return AST_TIMING_EVENT_CONTINUOUS;
130         case DAHDI_EVENT_TIMER_EXPIRED:
131         default:
132                 return AST_TIMING_EVENT_EXPIRED;        
133         }
134 }
135
136 static unsigned int dahdi_timer_get_max_rate(int handle)
137 {
138         return 1000;
139 }
140
141 #define SEE_TIMING "For more information on Asterisk timing modules, including ways to potentially fix this problem, please see https://wiki.asterisk.org/wiki/display/AST/Timing+Interfaces\n"
142
143 static int dahdi_test_timer(void)
144 {
145         int fd;
146         int x = 160;
147         
148         fd = open("/dev/dahdi/timer", O_RDWR);
149
150         if (fd < 0) {
151                 return -1;
152         }
153
154         if (ioctl(fd, DAHDI_TIMERCONFIG, &x)) {
155                 ast_log(LOG_ERROR, "You have DAHDI built and drivers loaded, but the DAHDI timer test failed to set DAHDI_TIMERCONFIG to %d.\n" SEE_TIMING, x);
156                 close(fd);
157                 return -1;
158         }
159
160         if ((x = ast_wait_for_input(fd, 300)) < 0) {
161                 ast_log(LOG_ERROR, "You have DAHDI built and drivers loaded, but the DAHDI timer could not be polled during the DAHDI timer test.\n" SEE_TIMING);
162                 close(fd);
163                 return -1;
164         }
165
166         if (!x) {
167                 const char dahdi_timer_error[] = {
168                         "Asterisk has detected a problem with your DAHDI configuration and will shutdown for your protection.  You have options:"
169                         "\n\t1. You only have to compile DAHDI support into Asterisk if you need it.  One option is to recompile without DAHDI support."
170                         "\n\t2. You only have to load DAHDI drivers if you want to take advantage of DAHDI services.  One option is to unload DAHDI modules if you don't need them."
171                         "\n\t3. If you need DAHDI services, you must correctly configure DAHDI."
172                 };
173                 ast_log(LOG_ERROR, "%s\n" SEE_TIMING, dahdi_timer_error);
174                 usleep(100);
175                 close(fd);
176                 return -1;
177         }
178
179         close(fd);
180
181         return 0;
182 }
183
184 static int load_module(void)
185 {
186         if (dahdi_test_timer()) {
187                 return AST_MODULE_LOAD_DECLINE;
188         }
189
190         return (timing_funcs_handle = ast_register_timing_interface(&dahdi_timing)) ?
191                 AST_MODULE_LOAD_SUCCESS : AST_MODULE_LOAD_DECLINE;
192 }
193
194 static int unload_module(void)
195 {
196         if (timing_funcs_handle) {
197                 return ast_unregister_timing_interface(timing_funcs_handle);
198         }
199
200         return 0;
201 }
202
203 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "DAHDI Timing Interface",
204                 .load = load_module,
205                 .unload = unload_module,
206                 .load_pri = AST_MODPRI_CHANNEL_DEPEND,
207                 );