support/serial.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2
   3 /* serial port functions
   4  *
   5  * Author: Chris Toshok <toshok@ximian.com>
   6  */
   7
   8 #include <termios.h>
   9 #include <unistd.h>
  10 #include <fcntl.h>
  11 #include <string.h>
  12 #include <sys/poll.h>
  13 #include <sys/ioctl.h>
  14 #include <errno.h>
  15
  16 #include <glib.h>
  17
  18 /* This is for FIONREAD on solaris */
  19 #if defined(sun)
  20 #include <sys/filio.h>
  21 #endif
  22
  23 /* sys/time.h (for timeval) is required when using osx 10.3 (but not 10.4) */
  24 #ifdef __APPLE__
  25 #include <sys/time.h>
  26 #endif
  27
  28 /* This is a copy of System.IO.Ports.Handshake */
  29 typedef enum {
  30         NoneHandshake = 0,
  31         XOnXOff = 1,
  32         RequestToSend = 2,
  33         RequestToSendXOnXOff = 3
  34 } MonoHandshake;
  35
  36 /* This is a copy of System.IO.Ports.Parity */
  37 typedef enum {
  38         NoneParity = 0,
  39         Odd = 1,
  40         Even = 2,
  41         Mark = 3,
  42         Space = 4
  43 } MonoParity;
  44
  45 /* This is a copy of System.IO.Ports.StopBits */
  46 typedef enum {
  47         NoneStopBits = 0,
  48         One = 1,
  49         Two = 2,
  50         OnePointFive = 3
  51 } MonoStopBits;
  52
  53 /* This is a copy of System.IO.Ports.SerialSignal */
  54 typedef enum {
  55         NoneSignal,
  56         Cd = 1, /* Carrier detect */
  57         Cts = 2, /* Clear to send */
  58         Dsr = 4, /* Data set ready */
  59         Dtr = 8, /* Data terminal ready */
  60         Rts = 16  /* Request to send */
  61 } MonoSerialSignal;
  62
  63 int
  64 open_serial (char* devfile)
  65 {
  66         int fd;
  67         fd = open (devfile, O_RDWR | O_NOCTTY | O_NONBLOCK);
  68
  69         if (fd == -1)
  70                 return -1;
  71
  72         return fd;
  73 }
  74
  75 void
  76 close_serial (int unix_fd)
  77 {
  78         close (unix_fd);
  79 }
  80
  81 guint32
  82 read_serial (int fd, guchar *buffer, int offset, int count)
  83 {
  84         guint32 n;
  85
  86         n = read (fd, buffer + offset, count);
  87
  88         return (guint32) n;
  89 }
  90
  91 int
  92 write_serial (int fd, guchar *buffer, int offset, int count, int timeout)
  93 {
  94         struct timeval tmval;
  95         fd_set writefs;
  96         guint32 n;
  97
  98         n = count - offset;
  99
 100         FD_SET(fd, &writefs);
 101         tmval.tv_sec = timeout / 1000;
 102         tmval.tv_usec = (timeout - tmval.tv_sec) * 1000;
 103
 104         while (n > 0)
 105         {
 106                 size_t t;
 107
 108                 if (timeout > 0)
 109                 {
 110                         if (select(fd+1, NULL, &writefs, NULL, &tmval) <= 0 && errno != EINTR)
 111                         {
 112                                 return -1;
 113                         }
 114                 }
 115
 116                 t = write(fd, buffer + offset, count);
 117
 118                 if (timeout > 0)
 119                 {
 120                         if (select(fd+1, NULL, &writefs, NULL, &tmval) <= 0  && errno != EINTR)
 121                         {
 122                                 return -1;
 123                         }
 124         }
 125
 126                 offset += t;
 127                 n -= t;
 128         }
 129
 130         return 0;
 131 }
 132
 133 void
 134 discard_buffer (int fd, gboolean input)
 135 {
 136         tcflush(fd, input ? TCIFLUSH : TCOFLUSH);
 137 }
 138
 139 gint32
 140 get_bytes_in_buffer (int fd, gboolean input)
 141 {
 142         gint32 retval;
 143
 144         if (ioctl (fd, input ? FIONREAD : TIOCOUTQ, &retval) == -1) {
 145                 return -1;
 146         }
 147
 148         return retval;
 149 }
 150
 151 gboolean
 152 set_attributes (int fd, int baud_rate, MonoParity parity, int dataBits, MonoStopBits stopBits, MonoHandshake handshake)
 153 {
 154         struct termios newtio;
 155
 156         tcgetattr (fd, &newtio);
 157         newtio.c_cflag |=  (CLOCAL | CREAD);
 158         newtio.c_lflag &= ~(ICANON | ECHO | ECHOE | ECHOK | ECHONL | ISIG | IEXTEN );
 159         newtio.c_oflag &= ~(OPOST);
 160         newtio.c_iflag = IGNBRK;
 161
 162         /* setup baudrate */
 163         switch (baud_rate)
 164         {
 165         case 230400:
 166             baud_rate = B230400;
 167             break;
 168         case 115200:
 169             baud_rate = B115200;
 170             break;
 171         case 57600:
 172             baud_rate = B57600;
 173             break;
 174         case 38400:
 175             baud_rate = B38400;
 176             break;
 177         case 19200:
 178             baud_rate = B19200;
 179             break;
 180         case 9600:
 181                 baud_rate = B9600;
 182                 break;
 183         case 4800:
 184             baud_rate = B4800;
 185                 break;
 186         case 2400:
 187             baud_rate = B2400;
 188                 break;
 189         case 1800:
 190             baud_rate = B1800;
 191                 break;
 192         case 1200:
 193             baud_rate = B1200;
 194                 break;
 195         case 600:
 196             baud_rate = B600;
 197             break;
 198         case 300:
 199             baud_rate = B300;
 200             break;
 201         case 200:
 202             baud_rate = B200;
 203             break;
 204         case 150:
 205             baud_rate = B150;
 206             break;
 207         case 134:
 208             baud_rate = B134;
 209             break;
 210         case 110:
 211             baud_rate = B110;
 212             break;
 213         case 75:
 214             baud_rate = B75;
 215             break;
 216         case 50:
 217         case 0:
 218         default:
 219             baud_rate = B9600;
 220                 break;
 221         }
 222
 223         /* char lenght */
 224         newtio.c_cflag &= ~CSIZE;
 225         switch (dataBits)
 226         {
 227         case 5:
 228             newtio.c_cflag |= CS5;
 229             break;
 230         case 6:
 231             newtio.c_cflag |= CS6;
 232             break;
 233         case 7:
 234             newtio.c_cflag |= CS7;
 235             break;
 236         case 8:
 237         default:
 238                 newtio.c_cflag |= CS8;
 239                 break;
 240         }
 241
 242         /* stopbits */
 243         switch (stopBits)
 244         {
 245         case NoneStopBits:
 246                 /* Unhandled */
 247                 break;
 248         case One: /* One */
 249                 /* do nothing, the default is one stop bit */
 250             newtio.c_cflag &= ~CSTOPB;
 251                 break;
 252         case Two: /* Two */
 253                 newtio.c_cflag |= CSTOPB;
 254                 break;
 255         case OnePointFive: /* OnePointFive */
 256                 /* XXX unhandled */
 257                 break;
 258         }
 259
 260         /* parity */
 261         newtio.c_iflag &= ~(INPCK | ISTRIP );
 262
 263         switch (parity)
 264         {
 265         case NoneParity: /* None */
 266             newtio.c_cflag &= ~(PARENB | PARODD);
 267             break;
 268
 269         case Odd: /* Odd */
 270             newtio.c_cflag |= PARENB | PARODD;
 271             break;
 272
 273         case Even: /* Even */
 274             newtio.c_cflag &= ~(PARODD);
 275             break;
 276
 277         case Mark: /* Mark */
 278             /* XXX unhandled */
 279             break;
 280         case Space: /* Space */
 281             /* XXX unhandled */
 282             break;
 283         }
 284
 285         newtio.c_iflag &= ~(IXOFF | IXON);
 286 #ifdef CRTSCTS
 287         newtio.c_cflag &= ~CRTSCTS;
 288 #endif /* def CRTSCTS */
 289
 290         switch (handshake)
 291         {
 292         case NoneHandshake: /* None */
 293                 /* do nothing */
 294                 break;
 295         case RequestToSend: /* RequestToSend (RTS) */
 296 #ifdef CRTSCTS
 297                 newtio.c_cflag |= CRTSCTS;
 298 #endif /* def CRTSCTS */
 299                 break;
 300         case RequestToSendXOnXOff: /* RequestToSendXOnXOff (RTS + XON/XOFF) */
 301 #ifdef CRTSCTS
 302                 newtio.c_cflag |= CRTSCTS;
 303 #endif /* def CRTSCTS */
 304                 /* fall through */
 305         case XOnXOff: /* XOnXOff */
 306             newtio.c_iflag |= IXOFF | IXON;
 307                 break;
 308         }
 309
 310         if (cfsetospeed (&newtio, baud_rate) < 0 || cfsetispeed (&newtio, baud_rate) < 0 ||
 311             tcsetattr (fd, TCSANOW, &newtio) < 0)
 312         {
 313                 return FALSE;
 314         }
 315         else
 316         {
 317         return TRUE;
 318         }
 319 }
 320
 321
 322 static gint32
 323 get_signal_code (MonoSerialSignal signal)
 324 {
 325         switch (signal) {
 326                 case Cd:
 327                         return TIOCM_CAR;
 328                 case Cts:
 329                         return TIOCM_CTS;
 330                 case Dsr:
 331                         return TIOCM_DSR;
 332                 case Dtr:
 333                         return TIOCM_DTR;
 334                 case Rts:
 335                         return TIOCM_RTS;
 336                 default:
 337                         return 0;
 338         }
 339
 340         /* Not reached */
 341         return 0;
 342 }
 343
 344 static MonoSerialSignal
 345 get_mono_signal_codes (int signals)
 346 {
 347         MonoSerialSignal retval = NoneSignal;
 348
 349         if ((signals & TIOCM_CAR) != 0)
 350                 retval |= Cd;
 351         if ((signals & TIOCM_CTS) != 0)
 352                 retval |= Cts;
 353         if ((signals & TIOCM_DSR) != 0)
 354                 retval |= Dsr;
 355         if ((signals & TIOCM_DTR) != 0)
 356                 retval |= Dtr;
 357         if ((signals & TIOCM_RTS) != 0)
 358                 retval |= Rts;
 359
 360         return retval;
 361 }
 362
 363 MonoSerialSignal
 364 get_signals (int fd, gint32 *error)
 365 {
 366         int signals;
 367
 368         *error = 0;
 369
 370         if (ioctl (fd, TIOCMGET, &signals) == -1) {
 371                 *error = -1;
 372                 return NoneSignal;
 373         }
 374
 375         return get_mono_signal_codes (signals);
 376 }
 377
 378 gint32
 379 set_signal (int fd, MonoSerialSignal signal, gboolean value)
 380 {
 381         int signals, expected, activated;
 382
 383         expected = get_signal_code (signal);
 384         if (ioctl (fd, TIOCMGET, &signals) == -1)
 385                 return -1;
 386
 387         activated = (signals & expected) != 0;
 388         if (activated == value) /* Already set */
 389                 return 1;
 390
 391         if (value)
 392                 signals |= expected;
 393         else
 394                 signals &= ~expected;
 395
 396         if (ioctl (fd, TIOCMSET, &signals) == -1)
 397                 return -1;
 398
 399         return 1;
 400 }
 401
 402 void
 403 breakprop (int fd)
 404 {
 405         tcsendbreak (fd, 0);
 406 }
 407
 408 gboolean
 409 poll_serial (int fd, gint32 *error, int timeout)
 410 {
 411         struct pollfd pinfo;
 412
 413         *error = 0;
 414
 415         pinfo.fd = fd;
 416         pinfo.events = POLLIN;
 417         pinfo.revents = 0;
 418
 419         while (poll (&pinfo, 1, timeout) == -1 && errno == EINTR) {
 420                 /* EINTR is an OK condition, we should not throw in the upper layer an IOException */
 421                 if (errno != EINTR){
 422                         *error = -1;
 423                         return FALSE;
 424                 }
 425         }
 426
 427         return (pinfo.revents & POLLIN) != 0 ? 1 : 0;
 428 }
 429
 430 /*
 431  * mono internals should not be used here.
 432  * this serial stuff needs to be implemented with icalls.
 433  * make this at least compile until the code is moved elsewhere
 434  * defined(linux) is wrong, too
 435  */
 436 void*
 437 list_serial_devices (void)
 438 {
 439         return NULL;
 440 }
 441
 442 #if 0
 443 MonoArray *
 444 list_serial_devices (void)
 445 {
 446         MonoArray *array;
 447 #if defined(linux)
 448         /* Linux serial files are of the form ttyS[0-9]+ */
 449         GSList *l, *list = NULL;
 450         GDir* dir = g_dir_open ("/dev", 0, NULL);
 451         const char *filename;
 452         int i = 0;
 453
 454         while ((filename = g_dir_read_name (dir))) {
 455                 if (filename) {
 456                         if (!strncmp (filename, "ttyS", 4))
 457                                 list = g_slist_append (list, g_strconcat ("/dev/", filename, NULL));
 458                 }
 459         }
 460
 461         g_dir_close (dir);
 462
 463         array = mono_array_new (mono_domain_get (), mono_get_string_class (), g_slist_length (list));
 464         for (l = list; l; l = l->next) {
 465                 mono_array_set (array, gpointer, i++, mono_string_new (mono_domain_get (), (char*)l->data));
 466                 g_free (l->data);
 467         }
 468
 469         g_slist_free (list);
 470
 471 #else
 472 #warning "list_serial_devices isn't ported to this OS"
 473 #endif
 474
 475         return array;
 476 }
 477 #endif
 478