miscutils/microcom.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * bare bones 'talk to modem' program - similar to 'cu -l $device'
   4  * inspired by mgetty's microcom
   5  *
   6  * Copyright (C) 2008 by Vladimir Dronnikov <dronnikov@gmail.com>
   7  *
   8  * Licensed under GPLv2, see file LICENSE in this source tree.
   9  */
  10 //config:config MICROCOM
  11 //config:       bool "microcom (5.6 kb)"
  12 //config:       default y
  13 //config:       help
  14 //config:       The poor man's minicom utility for chatting with serial port devices.
  15
  16 //applet:IF_MICROCOM(APPLET(microcom, BB_DIR_USR_BIN, BB_SUID_DROP))
  17
  18 //kbuild:lib-$(CONFIG_MICROCOM) += microcom.o
  19
  20 //usage:#define microcom_trivial_usage
  21 //usage:       "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
  22 //usage:#define microcom_full_usage "\n\n"
  23 //usage:       "Copy bytes for stdin to TTY and from TTY to stdout\n"
  24 //usage:     "\n        -d      Wait up to DELAY ms for TTY output before sending every"
  25 //usage:     "\n                next byte to it"
  26 //usage:     "\n        -t      Exit if both stdin and TTY are silent for TIMEOUT ms"
  27 //usage:     "\n        -s      Set serial line to SPEED"
  28 //usage:     "\n        -X      Disable special meaning of NUL and Ctrl-X from stdin"
  29
  30 #include "libbb.h"
  31 #include "common_bufsiz.h"
  32
  33 // set raw tty mode
  34 static void xget1(int fd, struct termios *t, struct termios *oldt)
  35 {
  36 //TODO: use set_termios_to_raw()
  37         tcgetattr(fd, oldt);
  38         *t = *oldt;
  39         cfmakeraw(t);
  40 //      t->c_lflag &= ~(ISIG|ICANON|ECHO|IEXTEN);
  41 //      t->c_iflag &= ~(BRKINT|IXON|ICRNL);
  42 //      t->c_oflag &= ~(ONLCR);
  43 //      t->c_cc[VMIN]  = 1;
  44 //      t->c_cc[VTIME] = 0;
  45 }
  46
  47 static int xset1(int fd, struct termios *tio, const char *device)
  48 {
  49         int ret = tcsetattr(fd, TCSAFLUSH, tio);
  50
  51         if (ret) {
  52                 bb_perror_msg("can't tcsetattr for %s", device);
  53         }
  54         return ret;
  55 }
  56
  57 int microcom_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
  58 int microcom_main(int argc UNUSED_PARAM, char **argv)
  59 {
  60         int sfd;
  61         int nfd;
  62         struct pollfd pfd[2];
  63         struct termios tio0, tiosfd, tio;
  64         char *device_lock_file;
  65         enum {
  66                 OPT_X = 1 << 0, // do not respect Ctrl-X, Ctrl-@
  67                 OPT_s = 1 << 1, // baudrate
  68                 OPT_d = 1 << 2, // wait for device response, ms
  69                 OPT_t = 1 << 3, // timeout, ms
  70         };
  71         speed_t speed = 9600;
  72         int delay = -1;
  73         int timeout = -1;
  74         unsigned opts;
  75
  76         // fetch options
  77         opts = getopt32(argv, "^" "Xs:+d:+t:+" "\0" "=1",
  78                                 &speed, &delay, &timeout
  79         );
  80 //      argc -= optind;
  81         argv += optind;
  82
  83         // try to create lock file in /var/lock
  84         device_lock_file = (char *)bb_basename(argv[0]);
  85         device_lock_file = xasprintf("/var/lock/LCK..%s", device_lock_file);
  86         sfd = open(device_lock_file, O_CREAT | O_WRONLY | O_TRUNC | O_EXCL, 0644);
  87         if (sfd < 0) {
  88                 // device already locked -> bail out
  89                 if (errno == EEXIST)
  90                         bb_perror_msg_and_die("can't create '%s'", device_lock_file);
  91                 // can't create lock -> don't care
  92                 if (ENABLE_FEATURE_CLEAN_UP)
  93                         free(device_lock_file);
  94                 device_lock_file = NULL;
  95         } else {
  96                 // %4d to make concurrent mgetty (if any) happy.
  97                 // Mgetty treats 4-bytes lock files as binary,
  98                 // not text, PID. Making 5+ char file. Brrr...
  99                 fdprintf(sfd, "%4d\n", getpid());
 100                 close(sfd);
 101         }
 102
 103         // setup signals
 104         bb_signals(0
 105                 + (1 << SIGHUP)
 106                 + (1 << SIGINT)
 107                 + (1 << SIGTERM)
 108                 + (1 << SIGPIPE)
 109                 , record_signo);
 110
 111         // error exit code if we fail to open the device
 112         bb_got_signal = 1;
 113
 114         // open device
 115         sfd = open_or_warn(argv[0], O_RDWR | O_NOCTTY | O_NONBLOCK);
 116         if (sfd < 0)
 117                 goto done;
 118         fcntl(sfd, F_SETFL, O_RDWR);
 119
 120         // put device to "raw mode"
 121         xget1(sfd, &tio, &tiosfd);
 122         // set device speed
 123         cfsetspeed(&tio, tty_value_to_baud(speed));
 124         if (xset1(sfd, &tio, argv[0]))
 125                 goto done;
 126
 127         // put stdin to "raw mode" (if stdin is a TTY),
 128         // handle one character at a time
 129         if (isatty(STDIN_FILENO)) {
 130                 xget1(STDIN_FILENO, &tio, &tio0);
 131                 if (xset1(STDIN_FILENO, &tio, "stdin"))
 132                         goto done;
 133         }
 134
 135         // main loop: check with poll(), then read/write bytes across
 136         pfd[0].fd = sfd;
 137         pfd[0].events = POLLIN;
 138         pfd[1].fd = STDIN_FILENO;
 139         pfd[1].events = POLLIN;
 140
 141         bb_got_signal = 0;
 142         nfd = 2;
 143         // Not safe_poll: we want to exit on signal
 144         while (!bb_got_signal && poll(pfd, nfd, timeout) > 0) {
 145                 if (nfd > 1 && pfd[1].revents) {
 146                         char c;
 147                         // read from stdin -> write to device
 148                         if (safe_read(STDIN_FILENO, &c, 1) < 1) {
 149                                 // don't poll stdin anymore if we got EOF/error
 150                                 nfd--;
 151                                 goto skip_write;
 152                         }
 153                         // do we need special processing?
 154                         if (!(opts & OPT_X)) {
 155                                 // ^@ sends Break
 156                                 if (VINTR == c) {
 157                                         tcsendbreak(sfd, 0);
 158                                         goto skip_write;
 159                                 }
 160                                 // ^X exits
 161                                 if (24 == c)
 162                                         break;
 163                         }
 164                         write(sfd, &c, 1);
 165                         if (delay >= 0)
 166                                 safe_poll(pfd, 1, delay);
 167 skip_write: ;
 168                 }
 169                 if (pfd[0].revents) {
 170                         ssize_t len;
 171 #define iobuf bb_common_bufsiz1
 172                         setup_common_bufsiz();
 173                         // read from device -> write to stdout
 174                         len = safe_read(sfd, iobuf, COMMON_BUFSIZE);
 175                         if (len > 0)
 176                                 full_write(STDOUT_FILENO, iobuf, len);
 177                         else {
 178                                 // EOF/error -> bail out
 179                                 bb_got_signal = SIGHUP;
 180                                 break;
 181                         }
 182                 }
 183         }
 184
 185         // restore device mode
 186         tcsetattr(sfd, TCSAFLUSH, &tiosfd);
 187
 188         if (isatty(STDIN_FILENO))
 189                 tcsetattr(STDIN_FILENO, TCSAFLUSH, &tio0);
 190
 191 done:
 192         if (device_lock_file)
 193                 unlink(device_lock_file);
 194
 195         return bb_got_signal;
 196 }