]> rtime.felk.cvut.cz Git - sojka/sterm.git/blobdiff - sterm.c
Add SEE ALSO section to manual page
[sojka/sterm.git] / sterm.c
diff --git a/sterm.c b/sterm.c
index ee7f8d70433e64d47db376efa2925dd188bbd5ee..c5fc0aa0d6a5d379412d8e8e90475ff7cb4a4dd6 100644 (file)
--- a/sterm.c
+++ b/sterm.c
@@ -1,7 +1,7 @@
 /*
  * Simple serial terminal
  *
- * Copyright 2014 Michal Sojka <sojkam1@fel.cvut.cz>
+ * Copyright 2014, 2015, 2016 Michal Sojka <sojkam1@fel.cvut.cz>
  *
  * This program is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License as
@@ -30,7 +30,9 @@
  */
 
 #define _BSD_SOURCE
+#define _DEFAULT_SOURCE
 #include <sys/ioctl.h>
+#include <sys/types.h>
 #include <unistd.h>
 #include <fcntl.h>
 #include <termios.h>
 #include <stdbool.h>
 #include <string.h>
 #include <signal.h>
+#include <lockdev.h>
 
 #define STRINGIFY(val) #val
 #define TOSTRING(val) STRINGIFY(val)
 #define CHECK(cmd) ({ int ret = (cmd); if (ret == -1) { perror(#cmd " line " TOSTRING(__LINE__)); exit(1); }; ret; })
 #define CHECKPTR(cmd) ({ void *ptr = (cmd); if (ptr == (void*)-1) { perror(#cmd " line " TOSTRING(__LINE__)); exit(1); }; ptr; })
+#define CHECKNULL(cmd) ({ void *ptr = (cmd); if (ptr == NULL) { perror(#cmd " line " TOSTRING(__LINE__)); exit(1); }; ptr; })
 
-#define VERBOSE(format, ...) do { if (verbose) fprintf(stderr, format, ##__VA_ARGS__); } while (0)
+#define VERBOSE(format, ...) do { if (verbose) fprintf(stderr, "sterm: " format, ##__VA_ARGS__); } while (0)
 
 bool verbose = false;
 bool exit_on_escape = true;
 
-char template[] = "/var/lock/TMPXXXXXX";
-char lockfile[100];
 struct termios stdin_tio_backup;
+char *dev = NULL;
 
 void rm_file(int status, void *arg)
 {
@@ -69,22 +72,32 @@ void restore_stdin_term()
        tcsetattr(0, TCSANOW, &stdin_tio_backup);
 }
 
+void unlock()
+{
+       dev_unlock(dev, getpid());
+}
+
 void sighandler(int arg)
 {
        exit(0); /* Invoke exit handlers */
 }
 
-int dtr_rts_arg(const char option)
+int dtr_rts_arg(const char option, const char *optarg)
 {
        int val = -1;
 
        if (optarg) {
-               switch (optarg[0]) {
-               case '+': val = +1; break;
-               case '-': val = -1; break;
-               default:
-                       fprintf(stderr, "Unknown -%c argument: %s", option, optarg);
-                       exit(1);
+               char *end;
+               val = strtol(optarg, &end, 10);
+               if (end == optarg) {
+                       /* Not a number */
+                       switch (optarg[0]) {
+                       case '+': val = +1; break;
+                       case '-': val = -1; break;
+                       default:
+                               fprintf(stderr, "Unknown -%c argument: %s\n", option, optarg);
+                               exit(1);
+                       }
                }
        }
        return val;
@@ -95,40 +108,109 @@ void exit_on_escapeseq(const char *buf, int len)
        static const char escseq[] = "\r~.";
        static const char *state = escseq+1;
        int i;
-
        for (i = 0; i < len; i++) {
                if (buf[i] == *state) {
                        state++;
                        if (*state == 0)
                                exit(0);
-               } else
+               } else {
                        state = escseq;
+                       if (buf[i] == *state)
+                               state++;
+               }
        }
 }
 
+void usage(const char* argv0)
+{
+       fprintf(stderr, "Usage: %s [options] <device>\n", argv0);
+       fprintf(stderr,
+               "Options:\n"
+               "  -c        enter command mode\n"
+               "  -d[PULSE] make pulse on DTR\n"
+               "  -e        ignore '~.' escape sequence\n"
+               "  -n        do not switch the device to raw mode\n"
+               "  -r[PULSE] make pulse on RTS\n"
+               "  -s <baudrate>\n"
+               "\n"
+               "PULSE is a number specifying the pulse. Absolute value defines the\n"
+               "length of the pulse in milliseconds, sign determines the polarity of\n"
+               "the pulse. Alternatively, PULSE can be either '+' or '-', which\n"
+               "corresponds to +1 or -1.\n"
+               );
+}
+
+void pulse(int fd, int dtr, int rts)
+{
+       int status, ms = 0;
+       /* tio.c_cflag &= ~HUPCL; */ /* Don't lower DTR/RTS on close */
+
+       CHECK(ioctl(fd, TIOCMGET, &status));
+       if (dtr > 0) { status &= ~TIOCM_DTR; ms = +dtr; }
+       if (dtr < 0) { status |=  TIOCM_DTR; ms = -dtr; }
+       if (rts > 0) { status &= ~TIOCM_RTS; ms = +rts; }
+       if (rts < 0) { status |=  TIOCM_RTS; ms = -rts; }
+       CHECK(ioctl(fd, TIOCMSET, &status));
+
+       usleep(ms*1000);
+
+       if (dtr < 0) { status &= ~TIOCM_DTR; }
+       if (dtr > 0) { status |=  TIOCM_DTR; }
+       if (rts < 0) { status &= ~TIOCM_RTS; }
+       if (rts > 0) { status |=  TIOCM_RTS; }
+       CHECK(ioctl(fd, TIOCMSET, &status));
+}
+
+void handle_commands(int fd)
+{
+       char command[100];
+       bool go = false;
+
+       while (!go) {
+               char *p1 = NULL;
+               if (fgets(command, sizeof(command), stdin) == NULL) {
+                       if (!feof(stdin))
+                           perror("Command read");
+                       exit(1);
+               }
+               if (sscanf(command, "dtr %ms", &p1) == 1)
+                       pulse(fd, dtr_rts_arg('d', p1), 0);
+               else if (sscanf(command, "rts %ms", &p1) == 1)
+                       pulse(fd, 0, dtr_rts_arg('r', p1));
+               else if (strcmp(command, "go\n") == 0)
+                       break;
+               else {
+                       fprintf(stderr, "Unknown command: %s\n", command);
+                       exit(1);
+               }
+
+               free(p1);
+       }
+}
 
 int main(int argc, char *argv[])
 {
        int fd;
-       char *dev = NULL;
        int opt;
        speed_t speed = 0;
        int dtr = 0, rts = 0;
        struct termios tio;
        bool stdin_tty;
        bool raw = true;
+       bool cmd = false;
 
        if ((stdin_tty = isatty(0))) {
                CHECK(tcgetattr(0, &stdin_tio_backup));
                atexit(restore_stdin_term);
        }
 
-       while ((opt = getopt(argc, argv, "nd::er::s:v")) != -1) {
+       while ((opt = getopt(argc, argv, "cnd::er::s:v")) != -1) {
                switch (opt) {
-               case 'd': dtr = dtr_rts_arg(opt); break;
+               case 'c': cmd = true; break;
+               case 'd': dtr = dtr_rts_arg(opt, optarg); break;
                case 'e': exit_on_escape = false; break;
                case 'n': raw = false; break;
-               case 'r': rts = dtr_rts_arg(opt); break;
+               case 'r': rts = dtr_rts_arg(opt, optarg); break;
                case 's': {
                        int s = atoi(optarg);
                        switch (s) {
@@ -163,7 +245,7 @@ int main(int argc, char *argv[])
                        verbose = true;
                        break;
                default: /* '?' */
-                       fprintf(stderr, "Usage: %s [-s baudrate] [-v] <device>\n", argv[0]);
+                       usage(argv[0]);
                        exit(1);
                }
        }
@@ -173,6 +255,7 @@ int main(int argc, char *argv[])
 
        if (!dev) {
                fprintf(stderr, "No device specified\n");
+               usage(argv[0]);
                exit(1);
        }
 
@@ -180,42 +263,24 @@ int main(int argc, char *argv[])
        signal(SIGTERM, sighandler);
        signal(SIGHUP, sighandler);
 
-       if (strncmp(dev, "/dev/", 5) == 0 &&
-           strrchr(dev, '/') == dev + 4 &&
-           dev[5] != 0)
-       { /* Create lock file (to be inter-operable with other programs) */
-               /* This is racy, but what we can do - see also comments in uucp / cu */
-               int tmp = CHECK(mkstemp(template));
-               on_exit(rm_file, template);
-               char pid[20];
-               snprintf(pid, sizeof(pid), "%u", getpid());
-               CHECK(write(tmp, pid, strlen(pid)));
-               close(tmp);
-               snprintf(lockfile, sizeof(lockfile), "/var/lock/LCK..%s", dev + 5);
-       retry:
-               if (link(template, lockfile) == -1) {
-                       tmp = CHECK(open(lockfile, O_RDONLY));
-                       CHECK(read(tmp, pid, sizeof(pid)));
-                       close(tmp);
-                       int p = atoi(pid);
-                       char proc[50];
-                       snprintf(proc, sizeof(proc), "/proc/%d", p);
-                       if (access(proc, F_OK) == 0) {
-                               fprintf(stderr, "%s is used by PID %d\n", dev, p);
-                               exit(1);
-                       }
-                       fprintf(stderr, "Stale lock file %s (PID %d) - removing it!\n", lockfile, p);
-                       CHECK(unlink(lockfile));
-                       goto retry;
-               }
-               rm_file(0, template);
-               on_exit(rm_file, lockfile);
+       pid_t pid = dev_lock(dev);
+       if (pid > 0) {
+               fprintf(stderr, "%s is used by PID %d\n", dev, pid);
+               exit(1);
+       } else if (pid < 0) {
+               perror("dev_lock()");
+               exit(1);
        }
+       atexit(unlock);
 
-       if ((fd = open(dev, O_RDWR)) < 0) {
+       /* O_NONBLOCK is needed to not wait for the CDC signal. See tty_ioctl(4). */
+       if ((fd = open(dev, O_RDWR|O_NOCTTY|O_NONBLOCK)) < 0) {
                perror(dev);
                exit(1);
        }
+        /* Cancel the efect of O_NONBLOCK flag. */
+       int n = fcntl(fd, F_GETFL, 0);
+        fcntl(fd, F_SETFL, n & ~O_NDELAY);
 
        if (isatty(fd)) {
                CHECK(ioctl(fd, TIOCEXCL, NULL));
@@ -229,17 +294,12 @@ int main(int argc, char *argv[])
                        CHECK(cfsetispeed(&tio, speed));
                }
 
-               if (dtr || rts) {
-                       int status;
-                       /* tio.c_cflag &= ~HUPCL; */ /* Don't lower DTR/RTS on close */
+               if (dtr || rts)
+                       pulse(fd, dtr, rts);
 
-                       CHECK(ioctl(fd, TIOCMGET, &status));
-                       if (dtr == -1) status &= ~TIOCM_DTR;
-                       if (dtr == +1) status |=  TIOCM_DTR;
-                       if (rts == -1) status &= ~TIOCM_RTS;
-                       if (rts == +1) status |=  TIOCM_RTS;
-                       CHECK(ioctl(fd, TIOCMSET, &status));
-               }
+                /* Disable flow control */
+               tio.c_cflag &= ~(CRTSCTS);
+               tio.c_iflag &= ~(IXON|IXOFF);
 
                CHECK(tcsetattr(fd, TCSANOW, &tio));
        } else if (speed || dtr || rts) {
@@ -247,6 +307,11 @@ int main(int argc, char *argv[])
                exit(1);
        }
 
+       VERBOSE("Connected.\r\n");
+
+       if (cmd)
+               handle_commands(fd);
+
        struct pollfd fds[2] = {
                { .fd = 0,  .events = POLLIN },
                { .fd = fd, .events = POLLIN },
@@ -260,14 +325,16 @@ int main(int argc, char *argv[])
                CHECK(tcsetattr(0, TCSANOW, &tio));
        }
 
-       VERBOSE("Connected.\n");
+       if (exit_on_escape)
+               VERBOSE("Use '<Enter>~.' sequence to exit.\r\n");
+
        while (1) {
                int r1, r2;
                CHECK(poll(fds, 2, -1));
                if (fds[0].revents & POLLIN) {
                        r1 = CHECK(read(0, buf, sizeof(buf)));
                        if (r1 == 0) {
-                               VERBOSE("EOF on stdin\n");
+                               VERBOSE("EOF on stdin\r\n");
                                break;
                        }
                        if (exit_on_escape)
@@ -281,7 +348,7 @@ int main(int argc, char *argv[])
                if (fds[1].revents & POLLIN) {
                        r1 = CHECK(read(fd, buf, sizeof(buf)));
                        if (r1 == 0) {
-                               VERBOSE("EOF on %s\n", dev);
+                               VERBOSE("EOF on %s\r\n", dev);
                                break;
                        }
                        r2 = CHECK(write(1, buf, r1));