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