Merge changes from timing branch
[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  ***/
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$");
33
34 #include <sys/types.h>
35 #include <sys/stat.h>
36 #include <fcntl.h>
37 #include <math.h>
38
39 #include "asterisk/module.h"
40 #include "asterisk/timing.h"
41 #include "asterisk/dahdi.h"
42 #include "asterisk/utils.h"
43
44 static void *timing_funcs_handle;
45
46 static int dahdi_timer_open(void);
47 static void dahdi_timer_close(int handle);
48 static int dahdi_timer_set_rate(int handle, unsigned int rate);
49 static void dahdi_timer_ack(int handle, unsigned int quantity);
50 static int dahdi_timer_enable_continuous(int handle);
51 static int dahdi_timer_disable_continuous(int handle);
52 static enum ast_timing_event dahdi_timer_get_event(int handle);
53
54 static struct ast_timing_functions dahdi_timing_functions = {
55         .timer_open = dahdi_timer_open,
56         .timer_close = dahdi_timer_close,
57         .timer_set_rate = dahdi_timer_set_rate,
58         .timer_ack = dahdi_timer_ack,
59         .timer_enable_continuous = dahdi_timer_enable_continuous,
60         .timer_disable_continuous = dahdi_timer_disable_continuous,
61         .timer_get_event = dahdi_timer_get_event,
62 };
63
64 static int dahdi_timer_open(void)
65 {
66         return open("/dev/dahdi/timer", O_RDWR);
67 }
68
69 static void dahdi_timer_close(int handle)
70 {
71         close(handle);
72 }
73
74 static int dahdi_timer_set_rate(int handle, unsigned int rate)
75 {
76         int samples;
77
78         /* DAHDI timers are configured using a number of samples,
79          * based on an 8 kHz sample rate. */
80         samples = (unsigned int) roundf((8000.0 / ((float) rate)));
81
82         if (ioctl(handle, DAHDI_TIMERCONFIG, &samples)) {
83                 ast_log(LOG_ERROR, "Failed to configure DAHDI timing fd for %u sample timer ticks\n",
84                         samples);
85                 return -1;
86         }
87
88         return 0;
89 }
90
91 static void dahdi_timer_ack(int handle, unsigned int quantity)
92 {
93         ioctl(handle, DAHDI_TIMERACK, &quantity);
94 }
95
96 static int dahdi_timer_enable_continuous(int handle)
97 {
98         int flags = 1;
99
100         return ioctl(handle, DAHDI_TIMERPING, &flags) ? -1 : 0;
101 }
102
103 static int dahdi_timer_disable_continuous(int handle)
104 {
105         int flags = -1;
106
107         return ioctl(handle, DAHDI_TIMERPONG, &flags) ? -1 : 0;
108 }
109
110 static enum ast_timing_event dahdi_timer_get_event(int handle)
111 {
112         int res;
113         int event;
114
115         res = ioctl(handle, DAHDI_GETEVENT, &event);
116
117         if (res) {
118                 event = DAHDI_EVENT_TIMER_EXPIRED;
119         }
120
121         switch (event) {
122         case DAHDI_EVENT_TIMER_PING:
123                 return AST_TIMING_EVENT_CONTINUOUS;
124         case DAHDI_EVENT_TIMER_EXPIRED:
125         default:
126                 return AST_TIMING_EVENT_EXPIRED;        
127         }
128 }
129
130 static int dahdi_test_timer(void)
131 {
132         int fd;
133         int x = 160;
134         
135         fd = open("/dev/dahdi/timer", O_RDWR);
136
137         if (fd < 0) {
138                 return -1;
139         }
140
141         if (ioctl(fd, DAHDI_TIMERCONFIG, &x)) {
142                 ast_log(LOG_ERROR, "You have DAHDI built and drivers loaded, but the DAHDI timer test failed to set DAHDI_TIMERCONFIG to %d.\n", x);
143                 close(fd);
144                 return -1;
145         }
146
147         if ((x = ast_wait_for_input(fd, 300)) < 0) {
148                 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");
149                 close(fd);
150                 return -1;
151         }
152
153         if (!x) {
154                 const char dahdi_timer_error[] = {
155                         "Asterisk has detected a problem with your DAHDI configuration and will shutdown for your protection.  You have options:"
156                         "\n\t1. You only have to compile DAHDI support into Asterisk if you need it.  One option is to recompile without DAHDI support."
157                         "\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."
158                         "\n\t3. If you need DAHDI services, you must correctly configure DAHDI."
159                 };
160                 ast_log(LOG_ERROR, "%s\n", dahdi_timer_error);
161                 usleep(100);
162                 close(fd);
163                 return -1;
164         }
165
166         close(fd);
167
168         return 0;
169 }
170
171 static int load_module(void)
172 {
173         if (dahdi_test_timer()) {
174                 return AST_MODULE_LOAD_DECLINE;
175         }
176
177         return (timing_funcs_handle = ast_install_timing_functions(&dahdi_timing_functions)) ?
178                 AST_MODULE_LOAD_SUCCESS : AST_MODULE_LOAD_DECLINE;
179 }
180
181 static int unload_module(void)
182 {
183         ast_uninstall_timing_functions(timing_funcs_handle);
184
185         return 0;
186 }
187
188 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "DAHDI Timing Interface");