devcfg.c

/*
 *  ser2net - A program for allowing telnet connection to serial ports
 *  Copyright (C) 2001  Corey Minyard <minyard@acm.org>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

/* This code handles generating the configuration for the serial port. */

#include <unistd.h>
#include <termios.h>
#include <sys/ioctl.h>
#include <sys/types.h>
#include <stdlib.h>
#include <string.h>
#include <stdio.h>

#include "devcfg.h"
#include "utils.h"

#ifdef __CYGWIN__
void cfmakeraw(struct termios *termios_p) {
    termios_p->c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP|INLCR|IGNCR|ICRNL|IXON);
    termios_p->c_oflag &= ~OPOST;
    termios_p->c_lflag &= ~(ECHO|ECHONL|ICANON|ISIG|IEXTEN);
    termios_p->c_cflag &= ~(CSIZE|PARENB);
    termios_p->c_cflag |= CS8;
}
#endif

/* Initialize a serial port control structure for the first time.
   This should only be called when the port is created.  It sets the
   port to the default 9600N81. */
void
devinit(struct termios *termctl)
{
    cfmakeraw(termctl);
    cfsetospeed(termctl, B9600);
    cfsetispeed(termctl, B9600);
    termctl->c_cflag &= ~(CSTOPB);
    termctl->c_cflag &= ~(CSIZE);
    termctl->c_cflag |= CS8;
    termctl->c_cflag &= ~(PARENB);
    termctl->c_cflag &= ~(CLOCAL);
    termctl->c_cflag &= ~(HUPCL);
    termctl->c_cflag |= CREAD;
    termctl->c_cflag &= ~(CRTSCTS);
    termctl->c_iflag &= ~(IXON | IXOFF | IXANY);
    termctl->c_iflag |= IGNBRK;
}

/* Configure a serial port control structure based upon input strings
   in instr.  These strings are described in the man page for this
   program. */
int
devconfig(char *instr, dev_info_t *dinfo)
{
    char *str;
    char *pos;
    char *strtok_data;
    int  rv = 0;
    struct termios *termctl = &dinfo->termctl;
    enum str_type stype;
    char *s;

    str = strdup(instr);
    if (str == NULL) {
	return -1;
    }

    dinfo->allow_2217 = 0;
    dinfo->disablebreak = 0;
    dinfo->banner = NULL;
    dinfo->signature = NULL;
    dinfo->openstr = NULL;
    dinfo->closestr = NULL;
    dinfo->trace_read.file = NULL;
    dinfo->trace_read.hexdump = 0;
    dinfo->trace_read.timestamp = 0;
    dinfo->trace_write.file = NULL;
    dinfo->trace_write.hexdump = 0;
    dinfo->trace_write.timestamp = 0;
    dinfo->trace_both.file = NULL;
    dinfo->trace_both.hexdump = 0;
    dinfo->trace_both.timestamp = 0;
    pos = strtok_r(str, ", \t", &strtok_data);
    while (pos != NULL) {
	if (strcmp(pos, "300") == 0) {
	    cfsetospeed(termctl, B300);
	    cfsetispeed(termctl, B300);
	} else if (strcmp(pos, "600") == 0) {
	    cfsetospeed(termctl, B600);
	    cfsetispeed(termctl, B600);
	} else if (strcmp(pos, "1200") == 0) {
	    cfsetospeed(termctl, B1200);
	    cfsetispeed(termctl, B1200);
	} else if (strcmp(pos, "2400") == 0) {
	    cfsetospeed(termctl, B2400);
	    cfsetispeed(termctl, B2400);
	} else if (strcmp(pos, "4800") == 0) {
	    cfsetospeed(termctl, B4800);
	    cfsetispeed(termctl, B4800);
	} else if (strcmp(pos, "9600") == 0) {
	    cfsetospeed(termctl, B9600);
	    cfsetispeed(termctl, B9600);
	} else if (strcmp(pos, "19200") == 0) {
	    cfsetospeed(termctl, B19200);
	    cfsetispeed(termctl, B19200);
	} else if (strcmp(pos, "38400") == 0) {
	    cfsetospeed(termctl, B38400);
	    cfsetispeed(termctl, B38400);
	} else if (strcmp(pos, "57600") == 0) {
	    cfsetospeed(termctl, B57600);
	    cfsetispeed(termctl, B57600);
	} else if (strcmp(pos, "115200") == 0) {
	    cfsetospeed(termctl, B115200);
	    cfsetispeed(termctl, B115200);
#ifdef B230400
	} else if (strcmp(pos, "230400") == 0) {
	    cfsetospeed(termctl, B230400);
	    cfsetispeed(termctl, B230400);
#endif
#ifdef B460800
	} else if (strcmp(pos, "460800") == 0) {
	    cfsetospeed(termctl, B460800);
	    cfsetispeed(termctl, B460800);
#endif
#ifdef B500000
	} else if (strcmp(pos, "500000") == 0) {
	    cfsetospeed(termctl, B500000);
	    cfsetispeed(termctl, B500000);
#endif
#ifdef B576000
	} else if (strcmp(pos, "576000") == 0) {
	    cfsetospeed(termctl, B576000);
	    cfsetispeed(termctl, B576000);
#endif
#ifdef B921600
	} else if (strcmp(pos, "921600") == 0) {
	    cfsetospeed(termctl, B921600);
	    cfsetispeed(termctl, B921600);
#endif
#ifdef B1000000
	} else if (strcmp(pos, "1000000") == 0) {
	    cfsetospeed(termctl, B1000000);
	    cfsetispeed(termctl, B1000000);
#endif
#ifdef B1152000
	} else if (strcmp(pos, "1152000") == 0) {
	    cfsetospeed(termctl, B1152000);
	    cfsetispeed(termctl, B1152000);
#endif
#ifdef B1500000
	} else if (strcmp(pos, "1500000") == 0) {
	    cfsetospeed(termctl, B1500000);
	    cfsetispeed(termctl, B1500000);
#endif
#ifdef B2000000
	} else if (strcmp(pos, "2000000") == 0) {
	    cfsetospeed(termctl, B2000000);
	    cfsetispeed(termctl, B2000000);
#endif
#ifdef B2500000
	} else if (strcmp(pos, "2500000") == 0) {
	    cfsetospeed(termctl, B2500000);
	    cfsetispeed(termctl, B2500000);
#endif
#ifdef B3000000
	} else if (strcmp(pos, "3000000") == 0) {
	    cfsetospeed(termctl, B3000000);
	    cfsetispeed(termctl, B3000000);
#endif
#ifdef B3500000
	} else if (strcmp(pos, "3500000") == 0) {
	    cfsetospeed(termctl, B3500000);
	    cfsetispeed(termctl, B3500000);
#endif
#ifdef B4000000
	} else if (strcmp(pos, "4000000") == 0) {
	    cfsetospeed(termctl, B4000000);
	    cfsetispeed(termctl, B4000000);	    
#endif
	} else if (strcmp(pos, "1STOPBIT") == 0) {
	    termctl->c_cflag &= ~(CSTOPB);
	} else if (strcmp(pos, "2STOPBITS") == 0) {
	    termctl->c_cflag |= CSTOPB;
	} else if (strcmp(pos, "7DATABITS") == 0) {
	    termctl->c_cflag &= ~(CSIZE);
	    termctl->c_cflag |= CS7;
	} else if (strcmp(pos, "8DATABITS") == 0) {
	    termctl->c_cflag &= ~(CSIZE);
	    termctl->c_cflag |= CS8;
	} else if (strcmp(pos, "NONE") == 0) {
	    termctl->c_cflag &= ~(PARENB);
	} else if (strcmp(pos, "EVEN") == 0) {
	    termctl->c_cflag |= PARENB;
	    termctl->c_cflag &= ~(PARODD);
	} else if (strcmp(pos, "ODD") == 0) {
	    termctl->c_cflag |= PARENB | PARODD;
        } else if (strcmp(pos, "XONXOFF") == 0) {
            termctl->c_iflag |= (IXON | IXOFF | IXANY);
            termctl->c_cc[VSTART] = 17;
            termctl->c_cc[VSTOP] = 19;      
        } else if (strcmp(pos, "-XONXOFF") == 0) {
            termctl->c_iflag &= ~(IXON | IXOFF | IXANY);
        } else if (strcmp(pos, "RTSCTS") == 0) {
            termctl->c_cflag |= CRTSCTS;  
        } else if (strcmp(pos, "-RTSCTS") == 0) {
            termctl->c_cflag &= ~CRTSCTS;
        } else if (strcmp(pos, "LOCAL") == 0) {
            termctl->c_cflag |= CLOCAL;  
        } else if (strcmp(pos, "-LOCAL") == 0) {
            termctl->c_cflag &= ~CLOCAL;
        } else if (strcmp(pos, "HANGUP_WHEN_DONE") == 0) {
            termctl->c_cflag |= HUPCL;  
        } else if (strcmp(pos, "-HANGUP_WHEN_DONE") == 0) {
            termctl->c_cflag &= ~HUPCL;
        } else if (strcmp(pos, "remctl") == 0) {
	    dinfo->allow_2217 = 1;
	} else if (strcmp(pos, "NOBREAK") == 0) {
	    dinfo->disablebreak = 1;
	} else if (strcmp(pos, "hexdump") == 0 ||
	           strcmp(pos, "-hexdump") == 0) {
	    dinfo->trace_read.hexdump = (*pos != '-');
	    dinfo->trace_write.hexdump = (*pos != '-');
	    dinfo->trace_both.hexdump = (*pos != '-');
	} else if (strcmp(pos, "timestamp") == 0 ||
	           strcmp(pos, "-timestamp") == 0) {
	    dinfo->trace_read.timestamp = (*pos != '-');
	    dinfo->trace_write.timestamp = (*pos != '-');
	    dinfo->trace_both.timestamp = (*pos != '-');
	} else if (strcmp(pos, "tr-hexdump") == 0 ||
	           strcmp(pos, "-tr-hexdump") == 0) {
	    dinfo->trace_read.hexdump = (*pos != '-');
	} else if (strcmp(pos, "tr-timestamp") == 0 ||
	           strcmp(pos, "-tr-timestamp") == 0) {
	    dinfo->trace_read.timestamp = (*pos != '-');
	} else if (strcmp(pos, "tw-hexdump") == 0 ||
	           strcmp(pos, "-tw-hexdump") == 0) {
	    dinfo->trace_write.hexdump = (*pos != '-');
	} else if (strcmp(pos, "tw-timestamp") == 0 ||
	           strcmp(pos, "-tw-timestamp") == 0) {
	    dinfo->trace_write.timestamp = (*pos != '-');
	} else if (strcmp(pos, "tb-hexdump") == 0 ||
	           strcmp(pos, "-tb-hexdump") == 0) {
	    dinfo->trace_both.hexdump = (*pos != '-');
	} else if (strcmp(pos, "tb-timestamp") == 0 ||
	           strcmp(pos, "-tb-timestamp") == 0) {
	    dinfo->trace_both.timestamp = (*pos != '-');
	} else if (strncmp(pos, "tr=", 3) == 0) {
	    /* trace read, data from the port to the socket */
	    dinfo->trace_read.file = find_tracefile(pos + 3);
	} else if (strncmp(pos, "tw=", 3) == 0) {
	    /* trace write, data from the socket to the port */
	    dinfo->trace_write.file = find_tracefile(pos + 3);
	} else if (strncmp(pos, "tb=", 3) == 0) {
	    /* trace both directions. */
	    dinfo->trace_both.file = find_tracefile(pos + 3);
	} else if ((s = find_str(pos, &stype))) {
	    /* It's a startup banner, signature or open/close string,
	       it's already set. */
	    switch (stype) {
	    case BANNER: dinfo->banner = s; break;
	    case SIGNATURE: dinfo->signature = s; break;
	    case OPENSTR: dinfo->openstr = s; break;
	    case CLOSESTR: dinfo->closestr = s; break;
	    }
	} else {
	    /* fprintf( stderr, "Unknown token %s\n", pos );     */
	    rv = -1;
	    goto out;
	}

	pos = strtok_r(NULL, ", \t", &strtok_data);
    }

out:
    free(str);
    return rv;
}

static char *
baud_string(int speed)
{
    char *str;
    switch (speed) {
    case B300: str = "300"; break;
    case B600: str = "600"; break;
    case B1200: str = "1200"; break;
    case B2400: str = "2400"; break;
    case B4800: str = "4800"; break;
    case B9600: str = "9600"; break;
    case B19200: str = "19200"; break;
    case B38400: str = "38400"; break;
    case B57600: str = "57600"; break;
    case B115200: str = "115200"; break;
#ifdef B230400
    case B230400: str = "230400"; break;
#endif
#ifdef B460800
    case B460800: str = "460800"; break;
#endif
#ifdef B500000
    case B500000: str = "500000"; break;
#endif
#ifdef B576000
    case B576000: str = "576000"; break;
#endif
#ifdef B921600
    case B921600: str = "921600"; break;
#endif
#ifdef B1000000
    case B1000000: str = "1000000"; break;
#endif
#ifdef B1152000
    case B1152000: str = "1152000"; break;
#endif
#ifdef B1500000
    case B1500000: str = "1500000"; break;
#endif
#ifdef B2000000
    case B2000000: str = "2000000"; break;
#endif
#ifdef B2500000
    case B2500000: str = "2500000"; break;
#endif
#ifdef B3000000
    case B3000000: str = "3000000"; break;
#endif
#ifdef B3500000
    case B3500000: str = "3500000"; break;
#endif
#ifdef B4000000
    case B4000000: str = "4000000"; break;
#endif
    default: str = "unknown speed";
    }
    return str;
}

void
serparm_to_str(char *str, int strlen, struct termios *termctl)
{
    speed_t speed = cfgetospeed(termctl);
    int     stopbits = termctl->c_cflag & CSTOPB;
    int     databits = termctl->c_cflag & CSIZE;
    int     parity_enabled = termctl->c_cflag & PARENB;
    int     parity = termctl->c_cflag & PARODD;
    char    *sstr;
    char    pchar, schar, dchar;

    sstr = baud_string(speed);

    if (stopbits) 
	schar = '2';
    else
	schar = '1';

    switch (databits) {
    case CS7: dchar = '7'; break;
    case CS8: dchar = '8'; break;
    default: dchar = '?';
    }

    if (parity_enabled) {
	if (parity) {
	    pchar = 'O';
	} else {
	    pchar = 'E';
	}
    } else {
	pchar = 'N';
    }

    snprintf(str, strlen, "%s %c%c%c", sstr, pchar, dchar, schar);
}

/* Send the serial port device configuration to the control port. */
void
show_devcfg(struct controller_info *cntlr, struct termios *termctl)
{
    speed_t speed = cfgetospeed(termctl);
    int     stopbits = termctl->c_cflag & CSTOPB;
    int     databits = termctl->c_cflag & CSIZE;
    int     parity_enabled = termctl->c_cflag & PARENB;
    int     parity = termctl->c_cflag & PARODD;
    int     xon = termctl->c_iflag & IXON;
    int     xoff = termctl->c_iflag & IXOFF;
    int     xany = termctl->c_iflag & IXANY;
    int     flow_rtscts = termctl->c_cflag & CRTSCTS;
    int     clocal = termctl->c_cflag & CLOCAL;
    int     hangup_when_done = termctl->c_cflag & HUPCL;
    char    *str;

    str = baud_string(speed);
    controller_output(cntlr, str, strlen(str));
    controller_output(cntlr, " ", 1);

    if (xon && xoff && xany) {
      controller_output(cntlr, "XONXOFF ", 8);
    }      
    
    if (flow_rtscts) {
      controller_output(cntlr, "RTSCTS ", 7);
    }

    if (clocal) {
      controller_output(cntlr, "LOCAL ", 6);
    }

    if (hangup_when_done) {
      controller_output(cntlr, "HANGUP_WHEN_DONE ", 17);
    }

    if (stopbits) {
	str = "2STOPBITS";
    } else {
	str = "1STOPBIT";
    }
    controller_output(cntlr, str, strlen(str));
    controller_output(cntlr, " ", 1);

    switch (databits) {
    case CS7: str = "7DATABITS"; break;
    case CS8: str = "8DATABITS"; break;
    default: str = "unknown databits";
    }
    controller_output(cntlr, str, strlen(str));
    controller_output(cntlr, " ", 1);

    if (parity_enabled) {
	if (parity) {
	    str = "ODD";
	} else {
	    str = "EVEN";
	}
    } else {
	str = "NONE";
    }
    controller_output(cntlr, str, strlen(str));
}

int
setdevcontrol(char *instr, int fd)
{
    int rv = 0;
    char *str;
    char *pos;
    int status;
    char *strtok_data;

    str = malloc(strlen(instr) + 1);
    if (str == NULL) {
	return -1;
    }

    strcpy(str, instr);

    pos = strtok_r(str, " \t", &strtok_data);
    while (pos != NULL) {
       if (strcmp(pos, "RTSHI") == 0) {
           ioctl(fd, TIOCMGET, &status);
           status |= TIOCM_RTS;
           ioctl(fd, TIOCMSET, &status);
       } else if (strcmp(pos, "RTSLO") == 0) {
           ioctl(fd, TIOCMGET, &status);
           status &= ~TIOCM_RTS;
           ioctl(fd, TIOCMSET, &status);
       } else if (strcmp(pos, "DTRHI") == 0) {
           ioctl(fd, TIOCMGET, &status);
           status |= TIOCM_DTR;
           ioctl(fd, TIOCMSET, &status);
       } else if (strcmp(pos, "DTRLO") == 0) {
           ioctl(fd, TIOCMGET, &status);
           status &= ~TIOCM_DTR;               /* AKA drop DTR */
           ioctl(fd, TIOCMSET, &status);
	} else {
	    rv = -1;
	    goto out;
	}

	pos = strtok_r(NULL, " \t", &strtok_data);
    }

out:
    free(str);
    return rv;
}

void
show_devcontrol(struct controller_info *cntlr, int fd)
{
    char *str;
    int  status;

    ioctl(fd, TIOCMGET, &status);

    if (status & TIOCM_RTS) {
	str = "RTSHI";
    } else {
	str = "RTSLO";
    }
    controller_output(cntlr, str, strlen(str));
    controller_output(cntlr, " ", 1);

    if (status & TIOCM_DTR) {
	str = "DTRHI";
    } else {
	str = "DTRLO";
    }
    controller_output(cntlr, str, strlen(str));
    controller_output(cntlr, " ", 1);
}