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"
  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:+", &speed, &delay, &timeout);
  78 //      argc -= optind;
  79         argv += optind;
  80
  81         // try to create lock file in /var/lock
  82         device_lock_file = (char *)bb_basename(argv[0]);
  83         device_lock_file = xasprintf("/var/lock/LCK..%s", device_lock_file);
  84         sfd = open(device_lock_file, O_CREAT | O_WRONLY | O_TRUNC | O_EXCL, 0644);
  85         if (sfd < 0) {
  86                 // device already locked -> bail out
  87                 if (errno == EEXIST)
  88                         bb_perror_msg_and_die("can't create '%s'", device_lock_file);
  89                 // can't create lock -> don't care
  90                 if (ENABLE_FEATURE_CLEAN_UP)
  91                         free(device_lock_file);
  92                 device_lock_file = NULL;
  93         } else {
  94                 // %4d to make concurrent mgetty (if any) happy.
  95                 // Mgetty treats 4-bytes lock files as binary,
  96                 // not text, PID. Making 5+ char file. Brrr...
  97                 fdprintf(sfd, "%4d\n", getpid());
  98                 close(sfd);
  99         }
 100
 101         // setup signals
 102         bb_signals(0
 103                 + (1 << SIGHUP)
 104                 + (1 << SIGINT)
 105                 + (1 << SIGTERM)
 106                 + (1 << SIGPIPE)
 107                 , record_signo);
 108
 109         // error exit code if we fail to open the device
 110         bb_got_signal = 1;
 111
 112         // open device
 113         sfd = open_or_warn(argv[0], O_RDWR | O_NOCTTY | O_NONBLOCK);
 114         if (sfd < 0)
 115                 goto done;
 116         fcntl(sfd, F_SETFL, O_RDWR);
 117
 118         // put device to "raw mode"
 119         xget1(sfd, &tio, &tiosfd);
 120         // set device speed
 121         cfsetspeed(&tio, tty_value_to_baud(speed));
 122         if (xset1(sfd, &tio, argv[0]))
 123                 goto done;
 124
 125         // put stdin to "raw mode" (if stdin is a TTY),
 126         // handle one character at a time
 127         if (isatty(STDIN_FILENO)) {
 128                 xget1(STDIN_FILENO, &tio, &tio0);
 129                 if (xset1(STDIN_FILENO, &tio, "stdin"))
 130                         goto done;
 131         }
 132
 133         // main loop: check with poll(), then read/write bytes across
 134         pfd[0].fd = sfd;
 135         pfd[0].events = POLLIN;
 136         pfd[1].fd = STDIN_FILENO;
 137         pfd[1].events = POLLIN;
 138
 139         bb_got_signal = 0;
 140         nfd = 2;
 141         // Not safe_poll: we want to exit on signal
 142         while (!bb_got_signal && poll(pfd, nfd, timeout) > 0) {
 143                 if (nfd > 1 && pfd[1].revents) {
 144                         char c;
 145                         // read from stdin -> write to device
 146                         if (safe_read(STDIN_FILENO, &c, 1) < 1) {
 147                                 // don't poll stdin anymore if we got EOF/error
 148                                 nfd--;
 149                                 goto skip_write;
 150                         }
 151                         // do we need special processing?
 152                         if (!(opts & OPT_X)) {
 153                                 // ^@ sends Break
 154                                 if (VINTR == c) {
 155                                         tcsendbreak(sfd, 0);
 156                                         goto skip_write;
 157                                 }
 158                                 // ^X exits
 159                                 if (24 == c)
 160                                         break;
 161                         }
 162                         write(sfd, &c, 1);
 163                         if (delay >= 0)
 164                                 safe_poll(pfd, 1, delay);
 165 skip_write: ;
 166                 }
 167                 if (pfd[0].revents) {
 168                         ssize_t len;
 169 #define iobuf bb_common_bufsiz1
 170                         setup_common_bufsiz();
 171                         // read from device -> write to stdout
 172                         len = safe_read(sfd, iobuf, COMMON_BUFSIZE);
 173                         if (len > 0)
 174                                 full_write(STDOUT_FILENO, iobuf, len);
 175                         else {
 176                                 // EOF/error -> bail out
 177                                 bb_got_signal = SIGHUP;
 178                                 break;
 179                         }
 180                 }
 181         }
 182
 183         // restore device mode
 184         tcsetattr(sfd, TCSAFLUSH, &tiosfd);
 185
 186         if (isatty(STDIN_FILENO))
 187                 tcsetattr(STDIN_FILENO, TCSAFLUSH, &tio0);
 188
 189 done:
 190         if (device_lock_file)
 191                 unlink(device_lock_file);
 192
 193         return bb_got_signal;
 194 }