2 * Copyright (c) 1986, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 static char sccsid[] = "@(#)unidialer.c 8.1 (Berkeley) 6/6/93";
38 static const char rcsid[] =
39 "$FreeBSD: src/usr.bin/tip/libacu/unidialer.c,v 1.7 1999/08/28 01:06:30 peter Exp $";
43 * Generalized routines for calling up on a Hayes AT command set based modem.
44 * Control variables are pulled out of a modem caps-style database to
45 * configure the driver for a particular modem.
49 #include "pathnames.h"
51 #include <sys/times.h>
57 #include "acucommon.h"
65 mpt_notype, mpt_string, mpt_number, mpt_boolean
69 modem_parm_type_t modem_parm_type;
84 static char modem_name [80];
85 static char *dial_command;
86 static char *hangup_command;
87 static char *echo_off_command;
88 static char *reset_command;
89 static char *init_string;
90 static char *escape_sequence;
91 static int hw_flow_control;
93 static unsigned int intercharacter_delay;
94 static unsigned int intercommand_delay;
95 static unsigned int escape_guard_time;
96 static unsigned int reset_delay;
98 static int unidialer_dialer (register char *num, char *acu);
99 static void unidialer_disconnect ();
100 static void unidialer_abort ();
102 static acu_t unidialer =
106 unidialer_disconnect,
111 Table of parameters kept in modem database
113 modem_parm_t modem_parms [] = {
114 { mpt_string, "dial_command", &dial_command, "ATDT%s\r" },
115 { mpt_string, "hangup_command", &hangup_command, "ATH\r", },
116 { mpt_string, "echo_off_command", &echo_off_command, "ATE0\r" },
117 { mpt_string, "reset_command", &reset_command, "ATZ\r" },
118 { mpt_string, "init_string", &init_string, "AT&F\r", },
119 { mpt_string, "escape_sequence", &escape_sequence, "+++" },
120 { mpt_boolean, "hw_flow_control", (char **)&hw_flow_control, NULL },
121 { mpt_boolean, "lock_baud", (char **)&lock_baud, NULL },
122 { mpt_number, "intercharacter_delay", (char **)&intercharacter_delay, (char *)50 },
123 { mpt_number, "intercommand_delay", (char **)&intercommand_delay, (char *)300 },
124 { mpt_number, "escape_guard_time", (char **)&escape_guard_time, (char *)300 },
125 { mpt_number, "reset_delay", (char **)&reset_delay, (char *)3000 },
126 { mpt_notype, NULL, NULL, NULL }
132 static void unidialer_verbose_read ();
133 static void unidialer_modem_cmd (int fd, CONST char *cmd);
134 static void unidialer_write (int fd, CONST char *cp, int n);
135 static void unidialer_write_str (int fd, CONST char *cp);
136 static void unidialer_disconnect ();
137 static void sigALRM ();
138 static int unidialersync ();
139 static int unidialer_swallow (register char *match);
144 static int timeout = 0;
145 static int connected = 0;
146 static jmp_buf timeoutbuf, intbuf;
148 #define cgetflag(f) (cgetcap(bp, f, ':') != NULL)
152 #define print_str(x) printf (#x " = %s\n", x)
153 #define print_num(x) printf (#x " = %d\n", x)
155 void dumpmodemparms (char *modem)
157 printf ("modem parms for %s\n", modem);
158 print_str (dial_command);
159 print_str (hangup_command);
160 print_str (echo_off_command);
161 print_str (reset_command);
162 print_str (init_string);
163 print_str (escape_sequence);
164 print_num (lock_baud);
165 print_num (intercharacter_delay);
166 print_num (intercommand_delay);
167 print_num (escape_guard_time);
168 print_num (reset_delay);
173 static int getmodemparms (const char *modem)
175 char *bp, *db_array [3], *modempath;
179 modempath = getenv ("MODEMS");
183 if (modempath != NULL)
184 db_array [ndx++] = modempath;
186 db_array [ndx++] = _PATH_MODEMS;
187 db_array [ndx] = NULL;
189 if ((stat = cgetent (&bp, db_array, (char *)modem)) < 0) {
192 warnx ("unknown modem %s", modem);
195 warnx ("can't open modem description file");
198 warnx ("possible reference loop in modem description file");
203 for (mpp = modem_parms; mpp->name; mpp++)
205 switch (mpp->modem_parm_type)
208 if (cgetstr (bp, (char *)mpp->name, mpp->value.string) == -1)
209 *mpp->value.string = mpp->default_value.string;
215 if (cgetnum (bp, (char *)mpp->name, &l) == -1)
216 *mpp->value.number = mpp->default_value.number;
218 *mpp->value.number = (unsigned int)l;
223 *mpp->value.number = cgetflag ((char *)mpp->name);
227 strncpy (modem_name, modem, sizeof (modem_name) - 1);
228 modem_name [sizeof (modem_name) - 1] = '\0';
234 acu_t* unidialer_getmodem (const char *modem_name)
237 if (getmodemparms (modem_name))
242 static int unidialer_modem_ready ()
246 ioctl (FD, TIOCMGET, &state);
247 return (state & TIOCM_DSR) ? 1 : 0;
253 static int unidialer_waitfor_modem_ready (int ms)
257 for (count = 0; count < ms; count += 100)
259 if (unidialer_modem_ready ())
262 printf ("unidialer_waitfor_modem_ready: modem ready.\n");
275 int unidialer_tty_clocal (int flag)
283 t.c_cflag &= ~CLOCAL;
284 tcsetattr (FD, TCSANOW, &t);
285 #elif defined(TIOCMSET)
288 Don't have CLOCAL so raise CD in software to
291 ioctl (FD, TIOCMGET, &state);
296 ioctl (FD, TIOCMSET, &state);
300 int unidialer_get_modem_response (char *buf, int bufsz, int response_timeout)
303 char c, *p = buf, *lid = buf + bufsz - 1;
308 f = signal (SIGALRM, sigALRM);
312 if (setjmp (timeoutbuf)) {
316 printf ("get_response: timeout buf=%s, state=%d\n", buf, state);
321 ualarm (response_timeout * 1000, 0);
330 if (read (FD, &c, 1) == 1)
339 printf ("get_response: unexpected char %s.\n", ctrl (c));
346 if (read (FD, &c, 1) == 1)
351 printf ("get_response: <CRLF> encountered.\n", buf);
359 printf ("get_response: unexpected char %s.\n", ctrl (c));
366 if (read (FD, &c, 1) == 1)
370 else if (c >= ' ' && p < lid)
376 if (read (FD, &c, 1) == 1)
385 printf ("get_response: %s\n", buf);
400 int unidialer_get_okay (int ms)
404 okay = unidialer_get_modem_response (buf, sizeof (buf), ms) &&
405 strcmp (buf, "OK") == 0;
409 static int unidialer_dialer (register char *num, char *acu)
412 char dial_string [80];
416 static int unidialer_connect(), unidialer_swallow();
419 dumpmodemparms (modem_name);
424 if ((i = speed(number(value(BAUDRATE)))) == 0)
429 if (boolean(value(VERBOSE)))
430 printf("Using \"%s\"\n", acu);
437 if (!unidialersync()) {
439 printf("tip: can't synchronize with %s\n", modem_name);
441 logent(value(HOST), num, modem_name, "can't synch up");
446 unidialer_modem_cmd (FD, echo_off_command); /* turn off echoing */
451 if (boolean(value(VERBOSE)))
452 unidialer_verbose_read();
455 acu_flush (); /* flush any clutter */
457 unidialer_modem_cmd (FD, init_string);
459 if (!unidialer_get_okay (reset_delay))
464 for (cp = num; *cp; cp++)
468 (void) sprintf (dial_string, dial_command, num);
470 unidialer_modem_cmd (FD, dial_string);
472 connected = unidialer_connect ();
474 if (connected && hw_flow_control) {
475 acu_hw_flow_control (hw_flow_control);
480 sprintf(line, "%d second dial timeout",
481 number(value(DIALTIMEOUT)));
482 logent(value(HOST), num, modem_name, line);
487 unidialer_disconnect ();
492 static void unidialer_disconnect ()
496 acu_flush (); /* flush any clutter */
498 unidialer_tty_clocal (TRUE);
500 /* first hang up the modem*/
501 ioctl (FD, TIOCCDTR, 0);
503 ioctl (FD, TIOCSDTR, 0);
506 * If AT&D2, then dropping DTR *should* just hangup the modem. But
507 * some modems reset anyway; also, the modem may be programmed to reset
508 * anyway with AT&D3. Play it safe and wait for the full reset time before
511 acu_nap (reset_delay);
513 if (!unidialer_waitfor_modem_ready (reset_delay))
516 printf ("unidialer_disconnect: warning CTS low.\r\n");
521 * If not strapped for DTR control, try to get command mode.
523 for (retries = okay = 0; retries < MAXRETRY && !okay; retries++)
526 /* flush any clutter */
530 printf ("unidialer_disconnect: warning flush failed.\r\n");
533 timeout_value = escape_guard_time;
534 timeout_value += (timeout_value * retries / MAXRETRY);
535 acu_nap (timeout_value);
536 acu_flush (); /* flush any clutter */
537 unidialer_modem_cmd (FD, escape_sequence);
538 acu_nap (timeout_value);
539 unidialer_modem_cmd (FD, hangup_command);
540 okay = unidialer_get_okay (reset_delay);
545 logent(value(HOST), "", modem_name, "can't hang up modem");
547 if (boolean(value(VERBOSE)))
548 printf("hang up failed\n");
554 static void unidialer_abort ()
556 unidialer_write_str (FD, "\r"); /* send anything to abort the call */
557 unidialer_disconnect ();
560 static void sigALRM ()
562 (void) printf("\07timeout waiting for reply\n");
564 longjmp(timeoutbuf, 1);
567 static int unidialer_swallow (register char *match)
572 f = signal(SIGALRM, sigALRM);
576 if (setjmp(timeoutbuf)) {
581 alarm(number(value(DIALTIMEOUT)));
594 if (boolean(value(VERBOSE)))
600 } while (c == *match++);
601 signal(SIGALRM, SIG_DFL);
604 if (boolean(value(VERBOSE)))
610 static struct baud_msg {
622 static int unidialer_connect ()
630 if (unidialer_swallow("\r\n") == 0)
632 f = signal(SIGALRM, sigALRM);
634 nc = 0; nl = sizeof(dialer_buf)-1;
635 bzero(dialer_buf, sizeof(dialer_buf));
637 for (nc = 0, nl = sizeof(dialer_buf)-1 ; nl > 0 ; nc++, nl--) {
638 if (setjmp(timeoutbuf))
640 alarm(number(value(DIALTIMEOUT)));
647 if (unidialer_swallow("\n") == 0)
651 if (strcmp(dialer_buf, "RINGING") == 0 &&
652 boolean(value(VERBOSE))) {
654 printf("%s\r\n", dialer_buf);
658 if (strncmp(dialer_buf, "CONNECT",
659 sizeof("CONNECT")-1) != 0)
664 if (boolean(value(VERBOSE)))
665 printf("%s\r\n", dialer_buf);
669 for (bm = baud_msg ; bm->msg ; bm++)
670 if (strcmp(bm->msg, dialer_buf+sizeof("CONNECT")-1) == 0) {
671 if (!acu_setspeed (bm->baud))
675 if (boolean(value(VERBOSE)))
676 printf("%s\r\n", dialer_buf);
685 printf("%s\r\n", dialer_buf);
692 * This convoluted piece of code attempts to get
693 * the unidialer in sync.
695 static int unidialersync ()
701 while (already++ < MAXRETRY) {
702 acu_nap (intercommand_delay);
703 acu_flush (); /* flush any clutter */
704 unidialer_write_str (FD, reset_command); /* reset modem */
705 bzero(buf, sizeof(buf));
706 acu_nap (reset_delay);
707 ioctl (FD, FIONREAD, &len);
709 len = read(FD, buf, sizeof(buf));
712 printf("unidialersync (%s): (\"%s\")\n\r", modem_name, buf);
714 if (index(buf, '0') ||
715 (index(buf, 'O') && index(buf, 'K')))
719 * If not strapped for DTR control,
720 * try to get command mode.
722 acu_nap (escape_guard_time);
723 unidialer_write_str (FD, escape_sequence);
724 acu_nap (escape_guard_time);
725 unidialer_write_str (FD, hangup_command);
727 * Toggle DTR to force anyone off that might have left
728 * the modem connected.
730 acu_nap (escape_guard_time);
731 ioctl (FD, TIOCCDTR, 0);
733 ioctl (FD, TIOCSDTR, 0);
735 acu_nap (intercommand_delay);
736 unidialer_write_str (FD, reset_command);
741 Send commands to modem; impose delay between commands.
743 static void unidialer_modem_cmd (int fd, const char *cmd)
745 static struct timeval oldt = { 0, 0 };
748 if (tod_lt (&newt, &oldt))
750 unsigned int naptime;
751 tod_subfrom (&oldt, newt);
752 naptime = oldt.tv_sec * 1000 + oldt.tv_usec / 1000;
753 if (naptime > intercommand_delay)
756 printf ("unidialer_modem_cmd: suspicious naptime (%u ms)\r\n", naptime);
758 naptime = intercommand_delay;
761 printf ("unidialer_modem_cmd: delaying %u ms\r\n", naptime);
765 unidialer_write_str (fd, cmd);
768 newt.tv_usec = intercommand_delay;
769 tod_addto (&oldt, &newt);
772 static void unidialer_write_str (int fd, const char *cp)
775 printf ("unidialer (%s): sending %s\n", modem_name, cp);
777 unidialer_write (fd, cp, strlen (cp));
780 static void unidialer_write (int fd, const char *cp, int n)
782 acu_nap (intercharacter_delay);
783 for ( ; n-- ; cp++) {
785 acu_nap (intercharacter_delay);
790 static void unidialer_verbose_read()
795 if (ioctl(FD, FIONREAD, &n) < 0)
799 if (read(FD, buf, n) != n)
805 /* end of unidialer.c */