Merged revisions 7799-7800 via svnmerge from
[asterisk/asterisk.git] / channels / chan_modem_bestdata.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999, Mark Spencer and 2001 Jim Dixon
5  *
6  * Mark Spencer <markster@linux-support.net>
7  * Jim Dixon <jim@lambdatel.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*
21  * \brief BestData 56SX-92 Voice Modem Driver (Conexant)
22  *
23  * \author Mark Spencer <markster@digium.com>
24  * \author Jim Dixon <jim@lambdatel.com>
25  *
26  * \ingroup channel_drivers
27  */
28
29 #include <stdio.h>
30
31 #include <string.h>
32 #include <stdlib.h>
33 #include <errno.h>
34 #include <unistd.h>
35
36 #include "asterisk.h"
37
38 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
39
40 #include "asterisk/lock.h"
41 #include "asterisk/vmodem.h"
42 #include "asterisk/module.h"
43 #include "asterisk/frame.h"
44 #include "asterisk/logger.h"
45 #include "asterisk/options.h"
46
47 #define STATE_COMMAND   0
48 #define STATE_VOICE     1
49 #define STATE_VOICEPLAY 2
50
51 #define VRA "40"                        /* Number of 100ms of non-ring after a ring cadence after which we consider the lien to be answered */
52 #define VRN "25"                        /* Number of 100ms of non-ring with no cadence after which we assume an answer */
53
54 #define RINGT   7000
55
56 static char *breakcmd = "\020!";
57
58 static char *desc = "BestData (Conexant V.90 Chipset) VoiceModem Driver";
59
60 static int usecnt;
61 AST_MUTEX_DEFINE_STATIC(usecnt_lock);
62
63 static char *bestdata_idents[] = {
64         /* Identify BestData Modem */
65         "ACF3_V1.010-V90_P21_FSH",
66         NULL
67 };
68
69 static int bestdata_break(struct ast_modem_pvt *p);
70
71 static int bestdata_startrec(struct ast_modem_pvt *p)
72 {
73         if (p->ministate != STATE_COMMAND) bestdata_break(p);
74         if (ast_modem_send(p, "AT+VRX", 0) ||
75              ast_modem_expect(p, "CONNECT", 5)) {
76                 ast_log(LOG_WARNING, "Unable to start recording\n");
77                 return -1;
78         }
79         p->ministate = STATE_VOICE;
80         return 0;
81 }
82
83 static int bestdata_startplay(struct ast_modem_pvt *p)
84 {
85         if (p->ministate != STATE_COMMAND) bestdata_break(p);
86         if (ast_modem_send(p, "AT+VTX", 0) ||
87              ast_modem_expect(p, "CONNECT", 5)) {
88                 ast_log(LOG_WARNING, "Unable to start recording\n");
89                 return -1;
90         }
91         p->ministate = STATE_VOICEPLAY;
92         return 0;
93 }
94
95 static int bestdata_break(struct ast_modem_pvt *p)
96 {
97         if (ast_modem_send(p, breakcmd, 2)) {
98                 ast_log(LOG_WARNING, "Failed to break\n");
99                 return -1;
100         }
101         p->ministate = STATE_COMMAND;
102         usleep(10000);
103         /* Read any outstanding junk */
104         while(!ast_modem_read_response(p, 1));
105         if (ast_modem_send(p, "AT", 0)) {
106                 /* Modem might be stuck in some weird mode, try to get it out */
107                 ast_modem_send(p, "+++", 3);
108                 if (ast_modem_expect(p, "OK", 10)) {
109                         ast_log(LOG_WARNING, "Modem is not responding\n");
110                         return -1;
111                 }
112                 if (ast_modem_send(p, "AT", 0)) {
113                         ast_log(LOG_WARNING, "Modem is not responding\n");
114                         return -1;
115                 }
116         }
117         if (ast_modem_expect(p, "OK", 5)) {
118                 ast_log(LOG_WARNING, "Modem did not respond properly\n");
119                 return -1;
120         }
121         return 0;
122 }
123
124 static int bestdata_init(struct ast_modem_pvt *p)
125 {
126         if (option_debug)
127                 ast_log(LOG_DEBUG, "bestdata_init()\n");
128         if (bestdata_break(p))
129                 return -1;
130         /* Force into command mode */
131         p->ministate = STATE_COMMAND;
132         if (ast_modem_send(p, "AT+FCLASS=8", 0) ||
133              ast_modem_expect(p, "OK", 5)) {
134                 ast_log(LOG_WARNING, "Unable to set to voice mode\n");
135                 return -1;
136         }
137         if (ast_modem_send(p, "AT+VSM=1,8000,0,0", 0) ||
138              ast_modem_expect(p, "OK", 5)) {
139                 ast_log(LOG_WARNING, "Unable to set to 8000 Hz sampling\n");
140                 return -1;
141         }
142         if (ast_modem_send(p, "AT+VLS=0", 0) ||
143              ast_modem_expect(p, "OK", 5)) {
144                 ast_log(LOG_WARNING, "Unable to set to telco interface\n");
145                 return -1;
146         }
147         if (ast_modem_send(p, "AT+VRA=" VRA, 0) ||
148              ast_modem_expect(p, "OK", 5)) {
149                 ast_log(LOG_WARNING, "Unable to set to 'ringback goes away' timer\n");
150                 return -1;
151         }
152         if (ast_modem_send(p, "AT+VRN=" VRN, 0) ||
153              ast_modem_expect(p, "OK", 5)) {
154                 ast_log(LOG_WARNING, "Unable to set to 'ringback never came timer'\n");
155                 return -1;
156         }
157         if (ast_modem_send(p, "AT+VTD=63", 0) ||
158              ast_modem_expect(p, "OK", 5)) {
159                 ast_log(LOG_WARNING, "Unable to set to tone detection\n");
160                 return -1;
161         }
162         if (ast_modem_send(p, "AT+VCID=1", 0) ||
163              ast_modem_expect(p, "OK", 5)) {
164                 ast_log(LOG_WARNING, "Unable to enable Caller*ID\n");
165                 return -1;
166         }
167         return 0;
168 }
169
170 static struct ast_frame *bestdata_handle_escape(struct ast_modem_pvt *p, char esc)
171 {
172         char name[30]="",nmbr[30]="";
173         time_t  now;
174
175         /* Handle escaped characters -- but sometimes we call it directly as 
176            a quick way to cause known responses */
177         p->fr.frametype = AST_FRAME_NULL;
178         p->fr.subclass = 0;
179         p->fr.data = NULL;
180         p->fr.datalen = 0;
181         p->fr.samples = 0;
182         p->fr.offset = 0;
183         p->fr.mallocd = 0;
184         p->fr.delivery.tv_sec = 0;
185         p->fr.delivery.tv_usec = 0;
186         if (esc)
187                 ast_log(LOG_DEBUG, "Escaped character '%c'\n", esc);
188         
189         switch(esc) {
190         case 'R': /* Pseudo ring */
191                 time(&now);
192                 if (now > (p->lastring + (RINGT / 1000)))
193                    { /* if stale, treat as new */
194                         p->gotclid = 0;
195                    }
196                 if (p->gotclid)
197                    {
198                         p->fr.frametype = AST_FRAME_CONTROL;
199                         p->fr.subclass = AST_CONTROL_RING;
200                    }
201                 p->ringt = RINGT;
202                 time(&p->lastring);
203                 return &p->fr;
204         case 'X': /* Caller-ID Spill */
205                 if (p->gotclid) return &p->fr;
206                 name[0] = nmbr[0] = 0;
207                 for(;;)
208                    {
209                         char res[1000]="";
210
211                         if (ast_modem_read_response(p, 5)) break;
212                         strncpy(res, p->response, sizeof(res)-1);
213                         ast_modem_trim(res);
214                         if (!strncmp(res,"\020.",2)) break;
215                         if (!strncmp(res,"NAME",4)) strncpy(name,res + 7, sizeof(name) - 1);
216                         if (!strncmp(res,"NMBR",4)) strncpy(nmbr,res + 7, sizeof(nmbr) - 1);
217                    }
218                 p->gotclid = 1;
219                 if ((!strcmp(name,"O")) || (!strcmp(name,"P"))) name[0] = 0;
220                 if ((!strcmp(nmbr,"O")) || (!strcmp(nmbr,"P"))) nmbr[0] = 0;
221                 if (name[0])
222                         strncpy(p->cid_name, name, sizeof(p->cid_name) - 1);
223                 if (nmbr[0])
224                         strncpy(p->cid_num, nmbr, sizeof(p->cid_num) - 1);
225                 if (p->owner) {
226                         p->owner->cid.cid_num = strdup(p->cid_num);
227                         p->owner->cid.cid_name = strdup(p->cid_name);
228                 }
229                 return &p->fr;
230         case '@': /* response from "OK" in command mode */
231                 if (p->owner)
232                         ast_setstate(p->owner, AST_STATE_UP);
233                 if (bestdata_startrec(p)) return NULL;
234                 p->fr.frametype = AST_FRAME_CONTROL;
235                 p->fr.subclass = AST_CONTROL_RING;
236                 return &p->fr;
237         case 'b': /* Busy signal */
238                 p->fr.frametype = AST_FRAME_CONTROL;
239                 p->fr.subclass = AST_CONTROL_BUSY;
240                 return &p->fr;
241         case 'o': /* Overrun */
242                 ast_log(LOG_WARNING, "Overflow on modem, flushing buffers\n");
243                 if (ast_modem_send(p, "\0x10E", 2)) 
244                         ast_log(LOG_WARNING, "Unable to flush buffers\n");
245                 return &p->fr;  
246         case '0':  /* All the DTMF characters */
247         case '1':
248         case '2':
249         case '3':
250         case '4':
251         case '5':
252         case '6':
253         case '7':
254         case '8':
255         case '9':
256         case '*':
257         case '#':
258         case 'A':
259         case 'B':
260         case 'C':
261         case 'D':
262                 p->dtmfrx = esc;  /* save this for when its done */
263                 return &p->fr;  
264         case '/': /* Start of DTMF tone shielding */
265                 p->dtmfrx = ' ';
266                 return &p->fr;  
267         case '~': /* DTMF transition to off */
268                 if (p->dtmfrx > ' ')
269                    {
270                         p->fr.frametype = AST_FRAME_DTMF;
271                         p->fr.subclass = p->dtmfrx;
272                    }
273                 p->dtmfrx = 0;
274                 return &p->fr;  
275         case 'u': /* Underrun */
276                 ast_log(LOG_WARNING, "Data underrun\n");
277                 /* Fall Through */
278         case CHAR_ETX: /* End Transmission */
279         case 'd': /* Dialtone */
280         case 'c': /* Calling Tone */
281         case 'e': /* European version */
282         case 'a': /* Answer Tone */
283         case 'f': /* Bell Answer Tone */
284         case 'T': /* Timing mark */
285         case 't': /* Handset off hook */
286         case 'h': /* Handset hungup */
287         case 0: /* Pseudo signal */
288                 /* Ignore */
289                 return &p->fr;  
290         default:
291                 ast_log(LOG_DEBUG, "Unknown Escaped character '%c' (%d)\n", esc, esc);
292         }
293         return &p->fr;
294 }
295
296 static struct ast_frame *bestdata_read(struct ast_modem_pvt *p)
297 {
298         char result[256];
299         short *b;
300         struct ast_frame *f=NULL;
301         int res;
302         int x;
303
304         if (p->ministate == STATE_COMMAND) {
305                 /* Read the first two bytes, first, in case it's a control message */
306                 fread(result, 1, 2, p->f);
307                 if (result[0] == CHAR_DLE) {
308                         return bestdata_handle_escape(p, result[1]);
309                 } else {
310                         if (p->ringt) /* if ring timeout specified */
311                            {
312                                 x = fileno(p->f);
313                                 res = ast_waitfor_n_fd(&x, 1, &p->ringt, NULL);
314                                 if (res < 0) {
315                                         return NULL;
316                                 }
317                            }
318                         if ((result[0] == '\n') || (result[0] == '\r'))
319                                 return bestdata_handle_escape(p, 0);
320                         /* Read the rest of the line */
321                         fgets(result + 2, sizeof(result) - 2, p->f);
322                         ast_modem_trim(result);
323                         if (!strcasecmp(result, "OK")) {
324                                 /* If we're in immediate mode, reply now */
325                                 if (p->mode == MODEM_MODE_IMMEDIATE)
326                                         return bestdata_handle_escape(p, '@');
327                         } else
328                         if (!strcasecmp(result, "BUSY")) {
329                                 /* Same as a busy signal */
330                                 return bestdata_handle_escape(p, 'b');
331                         } else
332                         if (!strcasecmp(result, "RING")) {
333                                 return bestdata_handle_escape(p, 'R');
334                         } else
335                         if (!strcasecmp(result, "NO DIALTONE")) {
336                                 /* There's no dialtone, so the line isn't working */
337                                 ast_log(LOG_WARNING, "Device '%s' lacking dialtone\n", p->dev);
338                                 return NULL;
339                         }
340                         ast_log(LOG_DEBUG, "Modem said '%s'\n", result);
341                         return bestdata_handle_escape(p, 0);
342                 }
343         } else {
344                   /* if playing, start recording instead */
345                 if (p->ministate == STATE_VOICEPLAY)
346                    {
347                         if (bestdata_startrec(p)) return NULL;
348                    }
349                 /* We have to be more efficient in voice mode */
350                 b = (short *)(p->obuf + p->obuflen);
351                 while (p->obuflen/2 < 240) {
352                         /* Read ahead the full amount */
353                         res = fread(result, 1, 240 - p->obuflen/2, p->f);
354                         if (res < 1) {
355                                 /* If there's nothing there, just continue on */
356                                 if (errno == EAGAIN)
357                                         return bestdata_handle_escape(p, 0);
358                                 ast_log(LOG_WARNING, "Read failed: %s\n", strerror(errno));
359                         }
360                         for (x=0;x<res;x++) {
361                                 /* Process all the bytes that we've read */
362                                 if (result[x] == CHAR_DLE) {
363                                         /* We assume there is no more than one signal frame among our
364                                            data.  */
365                                         if (f) ast_log(LOG_WARNING, "Warning: Dropped a signal frame\n");
366                                           /* if not a DLE in the data */
367                                         if (result[++x] != CHAR_DLE)
368                                            {
369                                                 /* If bestdata_handle_escape says NULL, say it now, doesn't matter
370                                                    what else is there, the connection is dead. */
371                                                 f = bestdata_handle_escape(p, result[x]);
372                                                 if (p->dtmfrx) continue;
373                                                 return(f);
374                                            }
375                                 }
376                                 /* Generate a 16-bit signed linear value from our 
377                                    unsigned 8-bit value */
378                                 *(b++) = (((short)result[x]) - 127) * 0xff;
379                                 p->obuflen += 2;
380                         }
381                         if (f) break;
382                 }
383                 /* If we have a control frame, return it now */
384                 if (f) return f;
385                 /* If we get here, we have a complete voice frame */
386                 p->fr.frametype = AST_FRAME_VOICE;
387                 p->fr.subclass = AST_FORMAT_SLINEAR;
388                 p->fr.samples = 240;
389                 p->fr.data = p->obuf;
390                 p->fr.datalen = p->obuflen;
391                 p->fr.mallocd = 0;
392                 p->fr.delivery.tv_sec = 0;
393                 p->fr.delivery.tv_usec = 0;
394                 p->fr.offset = AST_FRIENDLY_OFFSET;
395                 p->fr.src = __FUNCTION__;
396                 if (option_debug)
397                         ast_log(LOG_DEBUG, "bestdata_read(voice frame)\n");
398                 p->obuflen = 0;
399                 return &p->fr;
400         }
401         return NULL;
402 }
403
404 static int bestdata_write(struct ast_modem_pvt *p, struct ast_frame *f)
405 {
406 unsigned char   c,buf[32768]; /* I hope we dont have frames larger then 16K */
407 int     i,j;
408 short   *sp;
409 unsigned long u;
410 #define DLE     16
411
412         if (p->owner && (p->owner->_state == AST_STATE_UP) && 
413                 (p->ministate != STATE_VOICEPLAY) && bestdata_startplay(p)) return -1;
414         sp = (short *) f->data;
415           /* stick DLE's in ahead of anything else */
416         for(i = 0,j = 0; i < f->datalen / 2; i++)
417            {
418                 *sp *= 3;
419                 u = *sp++ + 32768;
420                 c = u >> 8;
421                 if (c == DLE) buf[j++] = DLE;
422                 buf[j++] = c;
423            }
424         do i = fwrite(buf,1,j,p->f);
425         while ((i == -1) && (errno == EWOULDBLOCK));
426         if (i != j)
427            {
428                 ast_log(LOG_WARNING,"modem short write!!\n");
429                 return -1;
430            }
431         fflush(p->f);
432         if (option_debug)
433                 ast_log(LOG_DEBUG, "bestdata_write()\n");
434         return 0;
435 }
436
437 static char *bestdata_identify(struct ast_modem_pvt *p)
438 {
439         char identity[256];
440         char mfr[80];
441         char mdl[80];
442         char rev[80];
443         ast_modem_send(p, "AT+FMM", 0);
444         ast_modem_read_response(p, 5);
445         strncpy(mdl, p->response, sizeof(mdl)-1);
446         ast_modem_trim(mdl);
447         ast_modem_expect(p, "OK", 5);
448         ast_modem_send(p, "AT+FMI", 0);
449         ast_modem_read_response(p, 5);
450         strncpy(mfr, p->response, sizeof(mfr)-1);
451         ast_modem_trim(mfr);
452         ast_modem_expect(p, "OK", 5);
453         ast_modem_send(p, "AT+FMR", 0);
454         ast_modem_read_response(p, 5);
455         strncpy(rev, p->response, sizeof(rev)-1);
456         ast_modem_trim(rev);
457         ast_modem_expect(p, "OK", 5);
458         snprintf(identity, sizeof(identity), "%s Model %s Revision %s", mfr, mdl, rev);
459         return strdup(identity);
460 }
461
462 static void bestdata_incusecnt(void)
463 {
464         ast_mutex_lock(&usecnt_lock);
465         usecnt++;
466         ast_mutex_unlock(&usecnt_lock);
467         ast_update_use_count();
468 }
469
470 static void bestdata_decusecnt(void)
471 {
472         ast_mutex_lock(&usecnt_lock);
473         usecnt++;
474         ast_mutex_unlock(&usecnt_lock);
475         ast_update_use_count();
476 }
477
478 static int bestdata_answer(struct ast_modem_pvt *p)
479 {
480         p->ringt = 0;
481         p->lastring = 0;
482         if (ast_modem_send(p, "AT+VLS=1", 0) ||
483              ast_modem_expect(p, "OK", 10)) {
484                 ast_log(LOG_WARNING, "Unable to answer: %s", p->response);
485                 return -1;
486         }
487         return 0;
488 }
489
490 static int bestdata_dialdigit(struct ast_modem_pvt *p, char digit)
491 {
492         char cmd[80];
493
494         if (p->ministate != STATE_COMMAND) bestdata_break(p);
495         snprintf(cmd, sizeof(cmd), "AT+VTS=%c", digit);
496         if (ast_modem_send(p, cmd, 0) ||
497              ast_modem_expect(p, "OK", 10)) {
498                 ast_log(LOG_WARNING, "Unable to answer: %s", p->response);
499                 return -1;
500         }
501         return 0;
502 }
503
504 static int bestdata_dial(struct ast_modem_pvt *p, char *stuff)
505 {
506         char cmd[800] = "",a[20]="";
507         int i,j;
508
509         if (p->ministate != STATE_COMMAND)
510            {
511                 bestdata_break(p);
512                 strncpy(cmd, "AT+VTS=", sizeof(cmd) - 1);
513                 j = strlen(cmd);
514                 for(i = 0; stuff[i]; i++)
515                    {
516                         switch(stuff[i])
517                            {
518                             case '!' :
519                                 a[0] = stuff[i];
520                                 a[1] = 0;
521                                 break;
522                             case ',':
523                                 strncpy(a, "[,,100]", sizeof(a) - 1);
524                                 break;
525                             default:
526                                 snprintf(a, sizeof(a), "{%c,7}", stuff[i]);
527                            }
528                         if (stuff[i + 1]) strncat(a, ",", sizeof(a) - strlen(a) - 1);
529                         strncpy(cmd + j, a, sizeof(cmd) - j - 1);
530                         j += strlen(a);
531                    }
532            }
533         else
534            {
535                 snprintf(cmd, sizeof(cmd), "ATD%c %s", p->dialtype,stuff);
536            }
537         if (ast_modem_send(p, cmd, 0)) {
538                 ast_log(LOG_WARNING, "Unable to dial\n");
539                 return -1;
540         }
541         return 0;
542 }
543
544 static int bestdata_hangup(struct ast_modem_pvt *p)
545 {
546         if (bestdata_break(p))
547                 return -1;
548         /* Hangup by switching to data, then back to voice */
549         if (ast_modem_send(p, "ATH", 0) ||
550              ast_modem_expect(p, "OK", 8)) {
551                 ast_log(LOG_WARNING, "Unable to set to data mode\n");
552                 return -1;
553         }
554         if (ast_modem_send(p, "AT+FCLASS=8", 0) ||
555              ast_modem_expect(p, "OK", 5)) {
556                 ast_log(LOG_WARNING, "Unable to set to voice mode\n");
557                 return -1;
558         }
559         p->gotclid = 0;
560         p->ringt = 0;
561         p->lastring = 0;
562         p->dtmfrx = 0;
563         return 0;
564 }
565
566 static struct ast_modem_driver bestdata_driver =
567 {
568         "BestData",
569         bestdata_idents,
570         AST_FORMAT_SLINEAR,
571         0,              /* Not full duplex */
572         bestdata_incusecnt,     /* incusecnt */
573         bestdata_decusecnt,     /* decusecnt */
574         bestdata_identify,      /* identify */
575         bestdata_init,  /* init */
576         NULL,   /* setdev */
577         bestdata_read,
578         bestdata_write,
579         bestdata_dial,  /* dial */
580         bestdata_answer,        /* answer */
581         bestdata_hangup,        /* hangup */
582         bestdata_startrec,      /* start record */
583         NULL,   /* stop record */
584         bestdata_startplay,     /* start playback */
585         NULL,   /* stop playback */
586         NULL,   /* set silence supression */
587         bestdata_dialdigit,     /* dialdigit */
588 };
589
590
591
592 int usecount(void)
593 {
594         return usecnt;
595 }
596
597 int load_module(void)
598 {
599         return ast_register_modem_driver(&bestdata_driver);
600 }
601
602 int unload_module(void)
603 {
604         return ast_unregister_modem_driver(&bestdata_driver);
605 }
606
607 char *description()
608 {
609         return desc;
610 }
611
612 char *key()
613 {
614         return ASTERISK_GPL_KEY;
615 }