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 <windows.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 static HANDLE hdl;
  39 #endif
  40
  41 static 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 SR_PRIV GSList *list_serial_ports(void)
  54 {
  55         GSList *ports;
  56
  57 #ifdef _WIN32
  58         /* TODO */
  59         ports = NULL;
  60         ports = g_slist_append(ports, g_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, g_strdup(g.gl_pathv[j]));
  71                 globfree(&g);
  72         }
  73 #endif
  74
  75         return ports;
  76 }
  77
  78 SR_PRIV 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 SR_PRIV 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 SR_PRIV 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 SR_PRIV 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 SR_PRIV 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 SR_PRIV void *serial_backup_params(int fd)
 160 {
 161 #ifdef _WIN32
 162         /* TODO */
 163 #else
 164         struct termios *term;
 165
 166         /* TODO: 'term' is never g_free()'d? */
 167         if (!(term = g_try_malloc(sizeof(struct termios)))) {
 168                 sr_err("serial: %s: term malloc failed", __func__);
 169                 return NULL;
 170         }
 171
 172         tcgetattr(fd, term);
 173
 174         return term;
 175 #endif
 176 }
 177
 178 SR_PRIV void serial_restore_params(int fd, void *backup)
 179 {
 180 #ifdef _WIN32
 181         /* TODO */
 182 #else
 183         tcsetattr(fd, TCSADRAIN, (struct termios *)backup);
 184 #endif
 185 }
 186
 187 /*
 188  * Set serial parameters.
 189  *
 190  * flowcontrol: 1 = rts/cts, 2 = xon/xoff
 191  * parity: 0 = none, 1 = even, 2 = odd
 192  */
 193 SR_PRIV int serial_set_params(int fd, int speed, int bits, int parity,
 194                               int stopbits, int flowcontrol)
 195 {
 196 #ifdef _WIN32
 197         DCB dcb;
 198
 199         if (!GetCommState(hdl, &dcb)) {
 200                 /* TODO: Error handling. */
 201                 return SR_ERR;
 202         }
 203
 204         /* TODO: Rename 'speed' to 'baudrate'. */
 205         switch(speed) {
 206         /* TODO: Support for higher baud rates. */
 207         case 115200:
 208                 dcb.BaudRate = CBR_115200;
 209                 break;
 210         case 57600:
 211                 dcb.BaudRate = CBR_57600;
 212                 break;
 213         case 38400:
 214                 dcb.BaudRate = CBR_38400;
 215                 break;
 216         case 19200:
 217                 dcb.BaudRate = CBR_19200;
 218                 break;
 219         case 9600:
 220                 dcb.BaudRate = CBR_9600;
 221                 break;
 222         default:
 223                 /* TODO: Error handling. */
 224                 break;
 225         }
 226         dcb.ByteSize = bits;
 227         dcb.Parity = NOPARITY; /* TODO: Don't hardcode. */
 228         dcb.StopBits = ONESTOPBIT; /* TODO: Don't hardcode. */
 229
 230         if (!SetCommState(hdl, &dcb)) {
 231                 /* TODO: Error handling. */
 232                 return SR_ERR;
 233         }
 234 #else
 235         struct termios term;
 236         speed_t baud;
 237
 238         switch (speed) {
 239         case 9600:
 240                 baud = B9600;
 241                 break;
 242         case 38400:
 243                 baud = B38400;
 244                 break;
 245         case 57600:
 246                 baud = B57600;
 247                 break;
 248         case 115200:
 249                 baud = B115200;
 250                 break;
 251 #ifndef __APPLE__
 252         case 460800:
 253                 baud = B460800;
 254                 break;
 255 #endif
 256         default:
 257                 return SR_ERR;
 258         }
 259
 260         if (tcgetattr(fd, &term) < 0)
 261                 return SR_ERR;
 262         if (cfsetispeed(&term, baud) < 0)
 263                 return SR_ERR;
 264
 265         term.c_cflag &= ~CSIZE;
 266         switch (bits) {
 267         case 8:
 268                 term.c_cflag |= CS8;
 269                 break;
 270         case 7:
 271                 term.c_cflag |= CS7;
 272                 break;
 273         default:
 274                 return SR_ERR;
 275         }
 276
 277         term.c_cflag &= ~CSTOPB;
 278         switch (stopbits) {
 279         case 1:
 280                 break;
 281         case 2:
 282                 term.c_cflag |= CSTOPB;
 283         default:
 284                 return SR_ERR;
 285         }
 286
 287         term.c_cflag &= ~(IXON | IXOFF | CRTSCTS);
 288         switch (flowcontrol) {
 289         case 2:
 290                 term.c_cflag |= IXON | IXOFF;
 291                 break;
 292         case 1:
 293                 term.c_cflag |= CRTSCTS;
 294         default:
 295                 return SR_ERR;
 296         }
 297
 298         term.c_iflag &= ~IGNPAR;
 299         term.c_cflag &= ~(PARODD | PARENB);
 300         switch (parity) {
 301         case 0:
 302                 term.c_iflag |= IGNPAR;
 303                 break;
 304         case 1:
 305                 term.c_cflag |= PARENB;
 306                 break;
 307         case 2:
 308                 term.c_cflag |= PARENB | PARODD;
 309                 break;
 310         default:
 311                 return SR_ERR;
 312         }
 313
 314         if (tcsetattr(fd, TCSADRAIN, &term) < 0)
 315                 return SR_ERR;
 316 #endif
 317
 318         return SR_OK;
 319 }