WARNING! dependency on: lace_cfgreader (branchpoint), lace_utils
authorshort <>
Sun, 25 Nov 2001 23:36:27 +0000 (23:36 +0000)
committershort <>
Sun, 25 Nov 2001 23:36:27 +0000 (23:36 +0000)
* new gnokiirc/global settings:
  * connect_script/disconnect_script - needed for BIP but can be general
    * entries in such sections passed as %ENV - ...
    * provided chat script ("connect-et" now) w/o bugs of "ppp-6210-modem"
  * serial_baudrate               - used when not overriden by phone
  * handshake = software/hardware - used when not overriden by phone
  * require_dcd - kills Gnokii when modem drops connection - needed for BIP
  * serial_write_usleep - waits between each character sent - for Siemens M20
* All open device fds are now closed and DTR/RTS-cleared on exit
  * SIGINT abort not properly handled - clashing with pthreads
* Fixed hang-ons by fcntl(FASYNC) forgotting to specify also FNONBLOCK

Docs/sample/cimd-connect [new file with mode: 0755]
Docs/sample/gnokiirc
common/devices/unixserial.c
include/devices/unixserial.h

diff --git a/Docs/sample/cimd-connect b/Docs/sample/cimd-connect
new file mode 100755 (executable)
index 0000000..1f190b0
--- /dev/null
@@ -0,0 +1,7 @@
+#! /usr/sbin/chat -vEf
+# ^^^ all options MUST be given as ONE word only (all are passed as ARGV[1])
+#     add/remove letter 'v' to echo all the commends to your syslog
+TIMEOUT 3 "" "ATZ" "OK-ATZ-OK" "" ABORT "BUSY" ABORT "NO CARRIER" ABORT "NO DIAL TONE" ABORT "ERROR" ABORT "VOICE" ""
+ATL2 OK
+ATD$TELEPHONE
+TIMEOUT 90 CONNECT \c ^M \c
index 845aca8..62bdc80 100644 (file)
@@ -32,3 +32,38 @@ connection = serial
 # permissions 4750, owned by root, group gnokii.  Ensure you
 # are in the gnokii group and that the group exists...
 bindir = /usr/local/sbin/
+
+# Baudrate to use on serial port connections.
+# Currently used only by models AT and BIP/CIMD. Defaults to 19200.
+serial_baudrate = 19200
+
+# Force waiting after each send character the specified usec time.
+# Value -1 forces the fastest 'block' writing,
+# value 0 writes each character separately without any explicite waiting,
+# other positive values specify the appropriate 1/1000000 sec delaying.
+# Siemens M20 requires at least "1"!  FIXME: Model-driven autodetection
+#serial_write_usleep = 10000
+
+# Force serial port handshaking mode, useful primarily for "AT" model.
+# Gnokii "AT" model uses software handshake by default.
+# Possible values: hardware (RTS/CTS - 7 wires) or software (XON/XOFF - 3 wires)
+#handshake = software
+
+# If defined (not commented out by '#') it will quit Gnokii anytime
+# when DCD line will drop.
+require_dcd = 1
+
+# Run the specified script(s) right after opening and initializing the device
+# and before any communucation (right before closing for disconnect_script).
+# You may find handy to use it to connect your modem to SMS Center
+# when using BIP or CIMD protocols
+# Non-absolute path is relative to the specific directory where gnokii is run!
+#connect_script = /absolute/path/to/gnokii/Docs/sample/cimd-connect
+#disconnect_script =
+
+# Any entries in the following two sections will be set as environment
+# variables when running the scripts.
+# Handy for use for $VAR substitutions in your chat(8) script.
+[connect_script]
+TELEPHONE = 12345678
+[disconnect_script]
index 5186465..1ca84cf 100644 (file)
   Released under the terms of the GNU GPL, see file COPYING for more details.
 
   $Log$
+  Revision 1.1.1.1.12.1  2001/11/25 23:31:56  short
+  WARNING! dependency on: lace_cfgreader (branchpoint), lace_utils
+
+  * new gnokiirc/global settings:
+    * connect_script/disconnect_script - needed for BIP but can be general
+      * entries in such sections passed as %ENV - ...
+      * provided chat script ("connect-et" now) w/o bugs of "ppp-6210-modem"
+    * serial_baudrate               - used when not overriden by phone
+    * handshake = software/hardware - used when not overriden by phone
+    * require_dcd - kills Gnokii when modem drops connection - needed for BIP
+    * serial_write_usleep - waits between each character sent - for Siemens M20
+  * All open device fds are now closed and DTR/RTS-cleared on exit
+    * SIGINT abort not properly handled - clashing with pthreads
+  * Fixed hang-ons by fcntl(FASYNC) forgotting to specify also FNONBLOCK
+
   Revision 1.1.1.1  2001/11/25 21:59:09  short
   :pserver:cvs@pserver.samba.org:/cvsroot - gnokii - Sun Nov 25 22:56 CET 2001
 
 
 */
 
+/* [global] option "serial_write_usleep" default: */
+#define SERIAL_WRITE_USLEEP_DEFAULT (-1)
+
 #include "misc.h"
+#include "cfgreader.h"
 
 /* Do not compile this file under Win32 systems. */
 
 #include <fcntl.h>
 #include <sys/ioctl.h>
 #include <string.h>
+#include <limits.h>
+#include <stdlib.h>
+#include <errno.h>
+#include <sys/types.h>
+#include <sys/wait.h>
+#include <sys/ioctl.h>
 
 #include <termios.h>
 #include "devices/unixserial.h"
 
 struct termios serial_termios;
 
+/* Script handling: */
+
+static void device_script_cfgfunc(const char *section,const char *key,const char *value)
+{
+  setenv(key,value,1/*overwrite*/);    /* errors ignored */
+}
+
+static int device_script(int fd, const char *section)
+{
+pid_t pid;
+const char *scriptname = CFG_Get(CFG_Info, "global", section);
+
+  if (!scriptname)
+    return(0);
+
+  errno=0;
+  switch ((pid=fork())) {
+    case -1:
+      fprintf(stderr,_("device_script(\"%s\"): fork() failure: %s!\n"),scriptname,strerror(errno));
+      return(-1);
+
+    default: { /* parent */
+int status;
+      if (pid==waitpid(pid,&status,0/*options*/) && WIFEXITED(status) && !WEXITSTATUS(status))
+       return(0);
+      fprintf(stderr,_("device_script(\"%s\"): child script failure: %s, exit code=%d\n"),scriptname,
+          (WIFEXITED(status) ? _("normal exit") : _("abnormal exit")),
+         (WIFEXITED(status) ? WEXITSTATUS(status) : -1));
+      errno=EIO;
+      return(-1);
+      }
+
+    case 0: {  /* child */
+      CFG_GetForeach(CFG_Info,section,device_script_cfgfunc);
+      errno=0;
+      if (0!=dup2(fd,0) || 1!=dup2(fd,1) || close(fd)) {
+       fprintf(stderr,_("device_script(\"%s\"): file descriptor prepare: %s\n"),scriptname,strerror(errno));
+       _exit(-1);
+       }
+      /* FIXME: close all open descriptors - how to track them?
+       */
+      execl("/bin/sh","sh","-c",scriptname,NULL);
+      fprintf(stderr,_("device_script(\"%s\"): execute script: %s\n"),scriptname,strerror(errno));
+      _exit(-1);
+      /* NOTREACHED */
+      }
+    }
+  /* NOTREACHED */
+}
+
+int serial_close_all_openfds[0x10];    /* -1 when entry not used, fd otherwise */
+int serial_close(int __fd);
+
+static void serial_close_all(void)
+{
+  int i;
+
+  dprintf("serial_close_all() executed\n");
+  for (i=0;i<ARRAY_LEN(serial_close_all_openfds);i++)
+    if (serial_close_all_openfds[i]!=-1)
+      serial_close(serial_close_all_openfds[i]);
+}
+
+static void unixserial_interrupted(int signo)
+{
+       exit(EXIT_FAILURE);
+       /* NOTREACHED */
+}
+
 /* Open the serial port and store the settings. */
 
 int serial_open(__const char *__file, int __oflag) {
 
   int __fd;
-  int retcode;
+  int retcode,i;
+  static bool atexit_registered=false;
+
+  if (!atexit_registered) {
+    memset(serial_close_all_openfds,-1,sizeof(serial_close_all_openfds));
+#if 0  /* Disabled for now as atexit() functions are then called multiple times for pthreads! */
+    signal(SIGINT,unixserial_interrupted);
+#endif
+    atexit(serial_close_all);
+    atexit_registered=true;
+    }
 
   __fd = open(__file, __oflag);
   if (__fd == -1) {
@@ -107,6 +211,12 @@ int serial_open(__const char *__file, int __oflag) {
     return (-1);
   }
 
+  for (i=0;i<ARRAY_LEN(serial_close_all_openfds);i++)
+    if (serial_close_all_openfds[i]==-1 || serial_close_all_openfds[i]==__fd) {
+      serial_close_all_openfds[i]=__fd;
+      break;
+      }
+
   retcode=tcgetattr(__fd, &serial_termios);
   if(retcode==-1) {
     perror("Gnokii serial_open:tcgetattr");
@@ -121,57 +231,75 @@ int serial_open(__const char *__file, int __oflag) {
 /* Close the serial port and restore old settings. */
 
 int serial_close(int __fd) {
+  int i;
+
+  for (i=0;i<ARRAY_LEN(serial_close_all_openfds);i++)
+    if (serial_close_all_openfds[i]==__fd)
+      serial_close_all_openfds[i]=-1;          /* fd closed */
+
+  /* handle config file disconnect_script:
+   */
+  if (-1 == device_script(__fd,"disconnect_script"))
+    fprintf(stderr,"Gnokii serial_close: disconnect_script\n");
+
+  if (__fd >= 0) {
+#if 1 /* HACK */
+    serial_termios.c_cflag |= HUPCL;   /* production == 1 */
+#else
+    serial_termios.c_cflag &= ~HUPCL;  /* debugging  == 0 */
+#endif
 
-  if (__fd >= 0)
     tcsetattr(__fd, TCSANOW, &serial_termios);
+    }
 
   return (close(__fd));
 }
 
-/* Open a device with standard options. */
-
+/* Open a device with standard options.
+ * Use value (-1) for "__with_hw_handshake" if its specification is required from the user
+ */
 int serial_opendevice(__const char *__file, int __with_odd_parity, int __with_async, int __with_hw_handshake) {
 
   int fd;
   int retcode;
   struct termios tp;
 
+  /* handle config file handshake override: */
+  {
+char *s=CFG_Get(CFG_Info, "global", "handshake");
+
+        if (s && (!strcasecmp(s,"software") || !strcasecmp(s,"rtscts")))
+      __with_hw_handshake=false;
+    else if (s && (!strcasecmp(s,"hardware") || !strcasecmp(s,"xonxoff")))
+      __with_hw_handshake=true;
+    else if (s)
+      fprintf(stderr,_("Unrecognized [%s] option \"%s\", use \"%s\" or \"%s\" value, ignoring!"),
+         "global","handshake","software","hardware");
+
+    if (__with_hw_handshake==-1) {
+      fprintf(stderr,_("[%s] option \"%s\" not found, trying to use \"%s\" value!"),
+         "global","handshake","software");
+      __with_hw_handshake=false;
+      }
+  }
+
   /* Open device */
 
+  /* O_NONBLOCK MUST be used here as the CLOCAL may be currently off
+   * and if DCD is down the "open" syscall would be stuck wating for DCD.
+   */
   fd = serial_open(__file, O_RDWR | O_NOCTTY | O_NONBLOCK);
 
   if (fd < 0) 
     return fd;
 
-  /* Allow process/thread to receive SIGIO */
-
-#if !(__unices__)
-  retcode = fcntl(fd, F_SETOWN, getpid());
-  if (retcode == -1){
-    perror("Gnokii serial_opendevice: fnctl(F_SETOWN)");
-    serial_close(fd);
-    return(-1);
-  }
-#endif
-
-  /* Make filedescriptor asynchronous. */
-
-  if (__with_async) {
-    retcode=fcntl(fd, F_SETFL, FASYNC);
-    if (retcode == -1){
-      perror("Gnokii serial_opendevice: fnctl(F_SETFL)");
-      serial_close(fd);
-      return(-1);
-    }
-  }
-  
   /* Initialise the port settings */
 
   memcpy(&tp, &serial_termios, sizeof(struct termios));
 
   /* Set port settings for canonical input processing */
 
-  tp.c_cflag = B0 | CS8 | CLOCAL | CREAD;
+  tp.c_cflag = B0 | CS8 | CLOCAL | CREAD | HUPCL;
   if (__with_odd_parity) {
     tp.c_cflag |= (PARENB | PARODD);
     tp.c_iflag = 0;
@@ -202,6 +330,61 @@ int serial_opendevice(__const char *__file, int __with_odd_parity, int __with_as
     return(-1);
   }
 
+  /* Set speed */
+  { 
+char *baudratestring=CFG_Get(CFG_Info, "global", "serial_baudrate");
+int baudrate=0;
+
+  if (baudratestring)
+    baudrate=atoi(baudratestring);
+  if (baudrate && GE_NONE!=serial_changespeed(fd,baudrate))
+    baudrate=0;
+  if (!baudrate)
+    serial_changespeed(fd,19200/*default value*/);
+  }
+
+  /* We need to turn off O_NONBLOCK now (we have CLOCAL set so it is safe).
+   * When we run some device script it really doesn't expect NONBLOCK!
+   */
+
+  retcode=fcntl(fd, F_SETFL, 0);
+  if (retcode == -1){
+    perror("Gnokii serial_opendevice: fnctl(F_SETFL)");
+    serial_close(fd);
+    return(-1);
+  }
+
+  /* handle config file connect_script:
+   */
+  if (-1 == device_script(fd,"connect_script")) {
+    fprintf(stderr,"Gnokii serial_opendevice: connect_script\n");
+    serial_close(fd);
+    return(-1);
+  }
+
+  /* Allow process/thread to receive SIGIO */
+
+#if !(__unices__)
+  retcode = fcntl(fd, F_SETOWN, getpid());
+  if (retcode == -1){
+    perror("Gnokii serial_opendevice: fnctl(F_SETOWN)");
+    serial_close(fd);
+    return(-1);
+  }
+#endif
+
+  /* Make filedescriptor asynchronous. */
+
+  /* We need to supply FNONBLOCK (or O_NONBLOCK) again as it would get reset
+   * by F_SETFL as a side-effect!
+   */
+  retcode=fcntl(fd, F_SETFL, (__with_async ? FASYNC : 0) | FNONBLOCK);
+  if (retcode == -1){
+    perror("Gnokii serial_opendevice: fnctl(F_SETFL)");
+    serial_close(fd);
+    return(-1);
+  }
+  
   return fd;
 }
 
@@ -239,9 +422,12 @@ int serial_select(int fd, struct timeval *timeout) {
 }
 
 
-/* Change the speed of the serial device. */
+/* Change the speed of the serial device.
+ * RETURNS: Success
+ */
 
-void serial_changespeed(int __fd, int __speed) {
+GSM_Error serial_changespeed(int __fd, int __speed) {
+  GSM_Error retcode = true;
 
 #ifndef SGTTY
   struct termios t;
@@ -257,26 +443,36 @@ void serial_changespeed(int __fd, int __speed) {
     case 38400:  speed = B38400;  break;
     case 57600:  speed = B57600;  break;
     case 115200: speed = B115200; break;
+    default:
+      fprintf(stderr,_("Serial port speed %d not supported!\n"),__speed);
+      return(GE_NOTSUPPORTED);
   }
 
 #ifndef SGTTY
-  tcgetattr(__fd, &t);
+  if (tcgetattr(__fd, &t))
+    retcode = GE_INTERNALERROR;
 
   // This is not needed! We set up the speed via cfsetspeed
   //  t.c_cflag &= ~CBAUD;
   //  t.c_cflag |= speed;
-  if (cfsetspeed(&t, speed) == -1)
-       dprintf(_("Serial port speed setting failed\n"));
+  if (cfsetspeed(&t, speed) == -1) {
+    dprintf(_("Serial port speed setting failed\n"));
+    retcode = GE_INTERNALERROR;
+    }
 
   tcsetattr(__fd, TCSADRAIN, &t);
 #else
-  ioctl(__fd, TIOCGETP, &t);
+  if (ioctl(__fd, TIOCGETP, &t))
+    retcode = GE_INTERNALERROR;
 
   t.sg_ispeed = speed;
   t.sg_ospeed = speed;
 
-  ioctl(__fd, TIOCSETN, &t);
+  if (ioctl(__fd, TIOCSETN, &t))
+    retcode = GE_INTERNALERROR;
 #endif
+
+  return(retcode);
 }
 
 /* Read from serial device. */
@@ -286,11 +482,65 @@ size_t serial_read(int __fd, __ptr_t __buf, size_t __nbytes) {
   return (read(__fd, __buf, __nbytes));
 }
 
+#if !defined(TIOCMGET) && defined(TIOCMODG)
+#define TIOCMGET TIOCMODG
+#endif
+
+static void check_dcd(int __fd)
+{
+#ifdef TIOCMGET
+int mcs;
+
+       if (ioctl(__fd, TIOCMGET, &mcs) || !(mcs & TIOCM_CAR)) {
+               fprintf(stderr,_("ERROR: Modem DCD is down and global/require_dcd parameter is set!\n"));
+               exit(EXIT_FAILURE);             /* Hard quit of all threads */
+               }
+#else
+       /* Impossible!! (eg. Coherent) */
+#endif
+}
+
 /* Write to serial device. */
 
 size_t serial_write(int __fd, __const __ptr_t __buf, size_t __n) {
-       
-       return (write(__fd, __buf, __n));
+
+size_t r=0;
+ssize_t got;
+static long serial_write_usleep=LONG_MIN;
+static int require_dcd=-1;
+
+       if (serial_write_usleep==LONG_MIN) {
+char *s=CFG_Get(CFG_Info, "global", "serial_write_usleep");
+
+               serial_write_usleep=(!s ?
+                       SERIAL_WRITE_USLEEP_DEFAULT : atol(CFG_Get(CFG_Info, "global", "serial_write_usleep")));
+               }
+
+       if (require_dcd==-1) {
+               require_dcd=(!!CFG_Get(CFG_Info, "global", "require_dcd"));
+#ifndef TIOCMGET
+               if (require_dcd)
+                       fprintf(stderr,_("WARNING: global/require_dcd argument was set but it is not supported on this system!\n"));
+#endif
+               }
+
+       if (require_dcd)
+               check_dcd(__fd);
+
+       if (serial_write_usleep<0)
+               return(write(__fd, __buf, __n));
+
+       while (__n>0) {
+               got=write(__fd, __buf, 1);
+               if (got<=0)
+                       return((!r ? -1 : r));
+               __buf++;
+               __n--;
+               r++;
+               if (serial_write_usleep)
+                       usleep(serial_write_usleep);
+               }
+       return(r);
 }
 
 #endif  /* WIN32 */
index 15253ef..58ff7e1 100644 (file)
   Released under the terms of the GNU GPL, see file COPYING for more details.
 
   $Log$
+  Revision 1.1.1.1.12.1  2001/11/25 23:31:57  short
+  WARNING! dependency on: lace_cfgreader (branchpoint), lace_utils
+
+  * new gnokiirc/global settings:
+    * connect_script/disconnect_script - needed for BIP but can be general
+      * entries in such sections passed as %ENV - ...
+      * provided chat script ("connect-et" now) w/o bugs of "ppp-6210-modem"
+    * serial_baudrate               - used when not overriden by phone
+    * handshake = software/hardware - used when not overriden by phone
+    * require_dcd - kills Gnokii when modem drops connection - needed for BIP
+    * serial_write_usleep - waits between each character sent - for Siemens M20
+  * All open device fds are now closed and DTR/RTS-cleared on exit
+    * SIGINT abort not properly handled - clashing with pthreads
+  * Fixed hang-ons by fcntl(FASYNC) forgotting to specify also FNONBLOCK
+
   Revision 1.1.1.1  2001/11/25 21:59:21  short
   :pserver:cvs@pserver.samba.org:/cvsroot - gnokii - Sun Nov 25 22:56 CET 2001
 
@@ -36,6 +51,7 @@
 #endif /* WIN32 */
 
 #include "misc.h"
+#include "gsm-error.h"
 
 int serial_open(__const char *__file, int __oflag);
 int serial_close(int __fd);
@@ -43,7 +59,7 @@ int serial_close(int __fd);
 int serial_opendevice(__const char *__file, int __with_odd_parity, int __with_async, int __with_hw_handshake);
 
 void serial_setdtrrts(int __fd, int __dtr, int __rts);
-void serial_changespeed(int __fd, int __speed);
+GSM_Error serial_changespeed(int __fd, int __speed);
 
 size_t serial_read(int __fd, __ptr_t __buf, size_t __nbytes);
 size_t serial_write(int __fd, __const __ptr_t __buf, size_t __n);