hardware/common/serial.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <string.h>
  21 #include <sys/types.h>
  22 #include <sys/stat.h>
  23 #include <fcntl.h>
  24 #include <unistd.h>
  25 #ifdef _WIN32
  26 #include <conio.h>
  27 #else
  28 #include <glob.h>
  29 #include <termios.h>
  30 #endif
  31 #include <stdlib.h>
  32 #include <glib.h>
  33 #include <sigrok.h>
  34 #include <sigrok-internal.h>
  35
  36 // FIXME: Must be moved, or rather passed as function argument.
  37 #ifdef _WIN32
  38 HANDLE hdl;
  39 #endif
  40
  41 const char *serial_port_glob[] = {
  42         /* Linux */
  43         "/dev/ttyS*",
  44         "/dev/ttyUSB*",
  45         "/dev/ttyACM*",
  46         /* MacOS X */
  47         "/dev/ttys*",
  48         "/dev/tty.USB-*",
  49         "/dev/tty.Modem-*",
  50         NULL,
  51 };
  52
  53 GSList *list_serial_ports(void)
  54 {
  55         GSList *ports;
  56
  57 #ifdef _WIN32
  58         /* TODO */
  59         ports = NULL;
  60         ports = g_slist_append(ports, strdup("COM1"));
  61 #else
  62         glob_t g;
  63         unsigned int i, j;
  64
  65         ports = NULL;
  66         for (i = 0; serial_port_glob[i]; i++) {
  67                 if (glob(serial_port_glob[i], 0, NULL, &g))
  68                         continue;
  69                 for (j = 0; j < g.gl_pathc; j++)
  70                         ports = g_slist_append(ports, strdup(g.gl_pathv[j]));
  71                 globfree(&g);
  72         }
  73 #endif
  74
  75         return ports;
  76 }
  77
  78 int serial_open(const char *pathname, int flags)
  79 {
  80 #ifdef _WIN32
  81         /* FIXME: Don't hardcode COM1. */
  82         hdl = CreateFile("COM1", GENERIC_READ | GENERIC_WRITE, 0, 0,
  83                          OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0);
  84         if (hdl == INVALID_HANDLE_VALUE) {
  85                 /* TODO: Error handling. */
  86         }
  87         return 0;
  88 #else
  89         return open(pathname, flags);
  90 #endif
  91 }
  92
  93 /*
  94  * Close the serial port.
  95  * Returns 0 upon success, -1 upon failure.
  96  */
  97 int serial_close(int fd)
  98 {
  99 #ifdef _WIN32
 100         /* Returns non-zero upon success, 0 upon failure. */
 101         return (CloseHandle(hdl) == 0) ? -1 : 0;
 102 #else
 103         /* Returns 0 upon success, -1 upon failure. */
 104         return close(fd);
 105 #endif
 106 }
 107
 108 /*
 109  * Flush serial port buffers (if any).
 110  * Returns 0 upon success, -1 upon failure.
 111  */
 112 int serial_flush(int fd)
 113 {
 114 #ifdef _WIN32
 115         /* Returns non-zero upon success, 0 upon failure. */
 116         return (PurgeComm(hdl, PURGE_RXCLEAR | PURGE_TXCLEAR) == 0) ? -1 : 0;
 117 #else
 118         /* Returns 0 upon success, -1 upon failure. */
 119         return tcflush(fd, TCIOFLUSH);
 120 #endif
 121 }
 122
 123 /*
 124  * Write a number of bytes to the specified serial port.
 125  * Returns the number of bytes written, or -1 upon failure.
 126  */
 127 int serial_write(int fd, const void *buf, size_t count)
 128 {
 129 #ifdef _WIN32
 130         DWORD tmp = 0;
 131
 132         /* FIXME */
 133         /* Returns non-zero upon success, 0 upon failure. */
 134         WriteFile(hdl, buf, count, &tmp, NULL);
 135 #else
 136         /* Returns the number of bytes written, or -1 upon failure. */
 137         return write(fd, buf, count);
 138 #endif
 139 }
 140
 141 /*
 142  * Read a number of bytes from the specified serial port.
 143  * Returns the number of bytes read, or -1 upon failure.
 144  */
 145 int serial_read(int fd, void *buf, size_t count)
 146 {
 147 #ifdef _WIN32
 148         DWORD tmp = 0;
 149
 150         /* FIXME */
 151         /* Returns non-zero upon success, 0 upon failure. */
 152         return ReadFile(hdl, buf, count, &tmp, NULL);
 153 #else
 154         /* Returns the number of bytes read, or -1 upon failure. */
 155         return read(fd, buf, count);
 156 #endif
 157 }
 158
 159 void *serial_backup_params(int fd)
 160 {
 161 #ifdef _WIN32
 162         /* TODO */
 163 #else
 164         struct termios *term;
 165
 166         term = malloc(sizeof(struct termios));
 167         tcgetattr(fd, term);
 168
 169         return term;
 170 #endif
 171 }
 172
 173 void serial_restore_params(int fd, void *backup)
 174 {
 175 #ifdef _WIN32
 176         /* TODO */
 177 #else
 178         tcsetattr(fd, TCSADRAIN, (struct termios *)backup);
 179 #endif
 180 }
 181
 182 /*
 183  * Set serial parameters.
 184  *
 185  * flowcontrol: 1 = rts/cts, 2 = xon/xoff
 186  * parity: 0 = none, 1 = even, 2 = odd
 187  */
 188 int serial_set_params(int fd, int speed, int bits, int parity, int stopbits,
 189                       int flowcontrol)
 190 {
 191 #ifdef _WIN32
 192         DCB dcb;
 193
 194         if (!GetCommState(hdl, &dcb)) {
 195                 /* TODO: Error handling. */
 196                 return SIGROK_ERR;
 197         }
 198
 199         /* TODO: Rename 'speed' to 'baudrate'. */
 200         switch(speed) {
 201         /* TODO: Support for higher baud rates. */
 202         case 115200:
 203                 dcb.BaudRate = CBR_115200;
 204                 break;
 205         case 57600:
 206                 dcb.BaudRate = CBR_57600;
 207                 break;
 208         case 38400:
 209                 dcb.BaudRate = CBR_38400;
 210                 break;
 211         case 19200:
 212                 dcb.BaudRate = CBR_19200;
 213                 break;
 214         case 9600:
 215                 dcb.BaudRate = CBR_9600;
 216                 break;
 217         default:
 218                 /* TODO: Error handling. */
 219                 break;
 220         }
 221         dcb.ByteSize = bits;
 222         dcb.Parity = NOPARITY; /* TODO: Don't hardcode. */
 223         dcb.StopBits = ONESTOPBIT; /* TODO: Don't hardcode. */
 224
 225         if (!SetCommState(hdl, &dcb)) {
 226                 /* TODO: Error handling. */
 227                 return SIGROK_ERR;
 228         }
 229 #else
 230         struct termios term;
 231         speed_t baud;
 232
 233         switch (speed) {
 234         case 9600:
 235                 baud = B9600;
 236                 break;
 237         case 38400:
 238                 baud = B38400;
 239                 break;
 240         case 57600:
 241                 baud = B57600;
 242                 break;
 243         case 115200:
 244                 baud = B115200;
 245                 break;
 246         case 460800:
 247                 baud = B460800;
 248                 break;
 249         default:
 250                 return SIGROK_ERR;
 251         }
 252
 253         if (tcgetattr(fd, &term) < 0)
 254                 return SIGROK_ERR;
 255         if (cfsetispeed(&term, baud) < 0)
 256                 return SIGROK_ERR;
 257
 258         term.c_cflag &= ~CSIZE;
 259         switch (bits) {
 260         case 8:
 261                 term.c_cflag |= CS8;
 262                 break;
 263         case 7:
 264                 term.c_cflag |= CS7;
 265                 break;
 266         default:
 267                 return SIGROK_ERR;
 268         }
 269
 270         term.c_cflag &= ~CSTOPB;
 271         switch (stopbits) {
 272         case 1:
 273                 break;
 274         case 2:
 275                 term.c_cflag |= CSTOPB;
 276         default:
 277                 return SIGROK_ERR;
 278         }
 279
 280         term.c_cflag &= ~(IXON | IXOFF | CRTSCTS);
 281         switch (flowcontrol) {
 282         case 2:
 283                 term.c_cflag |= IXON | IXOFF;
 284                 break;
 285         case 1:
 286                 term.c_cflag |= CRTSCTS;
 287         default:
 288                 return SIGROK_ERR;
 289         }
 290
 291         term.c_iflag &= ~IGNPAR;
 292         term.c_cflag &= ~(PARODD | PARENB);
 293         switch (parity) {
 294         case 0:
 295                 term.c_iflag |= IGNPAR;
 296                 break;
 297         case 1:
 298                 term.c_cflag |= PARENB;
 299                 break;
 300         case 2:
 301                 term.c_cflag |= PARENB | PARODD;
 302                 break;
 303         default:
 304                 return SIGROK_ERR;
 305         }
 306
 307         if (tcsetattr(fd, TCSADRAIN, &term) < 0)
 308                 return SIGROK_ERR;
 309 #endif
 310
 311         return SIGROK_OK;
 312 }