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