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 "map.h"
   9 #include "mph.h"
  10
  11 #include <termios.h>
  12 #include <unistd.h>
  13 #include <fcntl.h>
  14 #include <string.h>
  15 #include <errno.h>
  16 #if defined(HAVE_POLL_H)
  17 #include <poll.h>
  18 #elif defined(HAVE_SYS_POLL_H)
  19 #include <sys/poll.h>
  20 #endif
  21 #include <sys/ioctl.h>
  22
  23 /* This is for ASYNC_*, serial_struct on linux */
  24 #if defined(__linux__)
  25 #include <linux/serial.h>
  26 #endif
  27
  28 #include <glib.h>
  29
  30 /* This is for FIONREAD on solaris */
  31 #if defined(sun)
  32 #include <sys/filio.h>
  33 #endif
  34
  35 /* sys/time.h (for timeval) is required when using osx 10.3 (but not 10.4) */
  36 #ifdef __APPLE__
  37 #include <sys/time.h>
  38 #include <IOKit/IOKitLib.h>
  39 #include <IOKit/serial/IOSerialKeys.h>
  40 #include <IOKit/serial/ioss.h>
  41 #include <IOKit/IOBSD.h>
  42 #endif
  43
  44 /* This is a copy of System.IO.Ports.Handshake */
  45 typedef enum {
  46         NoneHandshake = 0,
  47         XOnXOff = 1,
  48         RequestToSend = 2,
  49         RequestToSendXOnXOff = 3
  50 } MonoHandshake;
  51
  52 /* This is a copy of System.IO.Ports.Parity */
  53 typedef enum {
  54         NoneParity = 0,
  55         Odd = 1,
  56         Even = 2,
  57         Mark = 3,
  58         Space = 4
  59 } MonoParity;
  60
  61 /* This is a copy of System.IO.Ports.StopBits */
  62 typedef enum {
  63         NoneStopBits = 0,
  64         One = 1,
  65         Two = 2,
  66         OnePointFive = 3
  67 } MonoStopBits;
  68
  69 /* This is a copy of System.IO.Ports.SerialSignal */
  70 typedef enum {
  71         NoneSignal,
  72         Cd = 1, /* Carrier detect */
  73         Cts = 2, /* Clear to send */
  74         Dsr = 4, /* Data set ready */
  75         Dtr = 8, /* Data terminal ready */
  76         Rts = 16  /* Request to send */
  77 } MonoSerialSignal;
  78
  79 /*
  80  * Silence the compiler, we do not need these prototypes to be public, since these are only
  81  * used by P/Invoke
  82  */
  83
  84 int              open_serial (char *devfile);
  85 int              close_serial (int unix_fd);
  86 guint32          read_serial (int fd, guchar *buffer, int offset, int count);
  87 int              write_serial (int fd, guchar *buffer, int offset, int count, int timeout);
  88 int              discard_buffer (int fd, gboolean input);
  89 gint32           get_bytes_in_buffer (int fd, gboolean input);
  90 gboolean         is_baud_rate_legal (int baud_rate);
  91 int              setup_baud_rate (int baud_rate, gboolean *custom_baud_rate);
  92 gboolean         set_attributes (int fd, int baud_rate, MonoParity parity, int dataBits, MonoStopBits stopBits, MonoHandshake handshake);
  93 MonoSerialSignal get_signals (int fd, gint32 *error);
  94 gint32           set_signal (int fd, MonoSerialSignal signal, gboolean value);
  95 int              breakprop (int fd);
  96 gboolean         poll_serial (int fd, gint32 *error, int timeout);
  97 void            *list_serial_devices (void);
  98
  99 int
 100 open_serial (char *devfile)
 101 {
 102         int fd;
 103         fd = open (devfile, O_RDWR | O_NOCTTY | O_NONBLOCK);
 104
 105         return fd;
 106 }
 107
 108 int
 109 close_serial (int unix_fd)
 110 {
 111         // Linus writes: do not retry close after EINTR
 112         return close (unix_fd);
 113 }
 114
 115 guint32
 116 read_serial (int fd, guchar *buffer, int offset, int count)
 117 {
 118         guint32 n;
 119
 120         n = read (fd, buffer + offset, count);
 121
 122         return (guint32) n;
 123 }
 124
 125 int
 126 write_serial (int fd, guchar *buffer, int offset, int count, int timeout)
 127 {
 128         struct pollfd pinfo;
 129         guint32 n;
 130
 131         pinfo.fd = fd;
 132         pinfo.events = POLLOUT;
 133         pinfo.revents = POLLOUT;
 134
 135         n = count;
 136
 137         while (n > 0)
 138         {
 139                 ssize_t t;
 140
 141                 if (timeout != 0) {
 142                         int c;
 143
 144                         while ((c = poll (&pinfo, 1, timeout)) == -1 && errno == EINTR)
 145                                 ;
 146                         if (c == -1)
 147                                 return -1;
 148                 }
 149
 150                 do {
 151                         t = write (fd, buffer + offset, n);
 152                 } while (t == -1 && errno == EINTR);
 153
 154                 if (t < 0)
 155                         return -1;
 156
 157                 offset += t;
 158                 n -= t;
 159         }
 160
 161         return 0;
 162 }
 163
 164 int
 165 discard_buffer (int fd, gboolean input)
 166 {
 167         return tcflush(fd, input ? TCIFLUSH : TCOFLUSH);
 168 }
 169
 170 gint32
 171 get_bytes_in_buffer (int fd, gboolean input)
 172 {
 173         gint32 retval;
 174
 175         if (ioctl (fd, input ? FIONREAD : TIOCOUTQ, &retval) == -1) {
 176                 return -1;
 177         }
 178
 179         return retval;
 180 }
 181
 182 gboolean
 183 is_baud_rate_legal (int baud_rate)
 184 {
 185         gboolean ignore = FALSE;
 186         return setup_baud_rate (baud_rate, &ignore) != -1;
 187 }
 188
 189 int
 190 setup_baud_rate (int baud_rate, gboolean *custom_baud_rate)
 191 {
 192         switch (baud_rate)
 193         {
 194 /*Some values are not defined on OSX and *BSD */
 195 #if defined(B921600)
 196         case 921600:
 197             baud_rate = B921600;
 198             break;
 199 #endif
 200 #if defined(B460800)
 201         case 460800:
 202             baud_rate = B460800;
 203             break;
 204 #endif
 205         case 230400:
 206             baud_rate = B230400;
 207             break;
 208         case 115200:
 209             baud_rate = B115200;
 210             break;
 211         case 57600:
 212             baud_rate = B57600;
 213             break;
 214         case 38400:
 215             baud_rate = B38400;
 216             break;
 217         case 19200:
 218             baud_rate = B19200;
 219             break;
 220         case 9600:
 221                 baud_rate = B9600;
 222                 break;
 223         case 4800:
 224             baud_rate = B4800;
 225                 break;
 226         case 2400:
 227             baud_rate = B2400;
 228                 break;
 229         case 1800:
 230             baud_rate = B1800;
 231                 break;
 232         case 1200:
 233             baud_rate = B1200;
 234                 break;
 235         case 600:
 236             baud_rate = B600;
 237             break;
 238         case 300:
 239             baud_rate = B300;
 240             break;
 241         case 200:
 242             baud_rate = B200;
 243             break;
 244         case 150:
 245             baud_rate = B150;
 246             break;
 247         case 134:
 248             baud_rate = B134;
 249             break;
 250         case 110:
 251             baud_rate = B110;
 252             break;
 253         case 75:
 254             baud_rate = B75;
 255             break;
 256         case 50:
 257 #ifdef B50
 258             baud_rate = B50;
 259 #else
 260             baud_rate = -1;
 261             break;
 262 #endif
 263         case 0:
 264 #ifdef B0
 265             baud_rate = B0;
 266 #else
 267             baud_rate = -1;
 268 #endif
 269             break;
 270         default:
 271                 *custom_baud_rate = TRUE;
 272                 break;
 273         }
 274         return baud_rate;
 275 }
 276
 277 gboolean
 278 set_attributes (int fd, int baud_rate, MonoParity parity, int dataBits, MonoStopBits stopBits, MonoHandshake handshake)
 279 {
 280         struct termios newtio;
 281         gboolean custom_baud_rate = FALSE;
 282
 283         if (tcgetattr (fd, &newtio) == -1)
 284                 return FALSE;
 285
 286         newtio.c_cflag |=  (CLOCAL | CREAD);
 287         newtio.c_lflag &= ~(ICANON | ECHO | ECHOE | ECHOK | ECHONL | ISIG | IEXTEN );
 288         newtio.c_oflag &= ~(OPOST);
 289         newtio.c_iflag = IGNBRK;
 290
 291         /* setup baudrate */
 292         baud_rate = setup_baud_rate (baud_rate, &custom_baud_rate);
 293
 294         /* char lenght */
 295         newtio.c_cflag &= ~CSIZE;
 296         switch (dataBits)
 297         {
 298         case 5:
 299             newtio.c_cflag |= CS5;
 300             break;
 301         case 6:
 302             newtio.c_cflag |= CS6;
 303             break;
 304         case 7:
 305             newtio.c_cflag |= CS7;
 306             break;
 307         case 8:
 308         default:
 309                 newtio.c_cflag |= CS8;
 310                 break;
 311         }
 312
 313         /* stopbits */
 314         switch (stopBits)
 315         {
 316         case NoneStopBits:
 317                 /* Unhandled */
 318                 break;
 319         case One: /* One */
 320                 /* do nothing, the default is one stop bit */
 321             newtio.c_cflag &= ~CSTOPB;
 322                 break;
 323         case Two: /* Two */
 324                 newtio.c_cflag |= CSTOPB;
 325                 break;
 326         case OnePointFive: /* OnePointFive */
 327                 /* XXX unhandled */
 328                 break;
 329         }
 330
 331         /* parity */
 332         newtio.c_iflag &= ~(INPCK | ISTRIP );
 333
 334         switch (parity)
 335         {
 336         case NoneParity: /* None */
 337             newtio.c_cflag &= ~(PARENB | PARODD);
 338             break;
 339
 340         case Odd: /* Odd */
 341             newtio.c_cflag |= PARENB | PARODD;
 342             break;
 343
 344         case Even: /* Even */
 345             newtio.c_cflag &= ~(PARODD);
 346             newtio.c_cflag |= (PARENB);
 347             break;
 348
 349         case Mark: /* Mark */
 350             /* XXX unhandled */
 351             break;
 352         case Space: /* Space */
 353             /* XXX unhandled */
 354             break;
 355         }
 356
 357         newtio.c_iflag &= ~(IXOFF | IXON);
 358 #ifdef CRTSCTS
 359         newtio.c_cflag &= ~CRTSCTS;
 360 #endif /* def CRTSCTS */
 361
 362         switch (handshake)
 363         {
 364         case NoneHandshake: /* None */
 365                 /* do nothing */
 366                 break;
 367         case RequestToSend: /* RequestToSend (RTS) */
 368 #ifdef CRTSCTS
 369                 newtio.c_cflag |= CRTSCTS;
 370 #endif /* def CRTSCTS */
 371                 break;
 372         case RequestToSendXOnXOff: /* RequestToSendXOnXOff (RTS + XON/XOFF) */
 373 #ifdef CRTSCTS
 374                 newtio.c_cflag |= CRTSCTS;
 375 #endif /* def CRTSCTS */
 376                 /* fall through */
 377         case XOnXOff: /* XOnXOff */
 378             newtio.c_iflag |= IXOFF | IXON;
 379                 break;
 380         }
 381
 382         if (custom_baud_rate == FALSE) {
 383                 if (cfsetospeed (&newtio, baud_rate) < 0 || cfsetispeed (&newtio, baud_rate) < 0)
 384                         return FALSE;
 385         } else {
 386 #if __linux__ || __APPLE__
 387
 388                 /* On Linux to set a custom baud rate, we must set the
 389                  * "standard" baud_rate to 38400.   On Apple we set it purely
 390                  * so that tcsetattr has something to use (and report back later), but
 391                  * the Apple specific API is still opaque to these APIs, see:
 392                  * https://developer.apple.com/library/mac/samplecode/SerialPortSample/Listings/SerialPortSample_SerialPortSample_c.html#//apple_ref/doc/uid/DTS10000454-SerialPortSample_SerialPortSample_c-DontLinkElementID_4
 393                  */
 394                 if (cfsetospeed (&newtio, B38400) < 0 || cfsetispeed (&newtio, B38400) < 0)
 395                         return FALSE;
 396 #endif
 397         }
 398
 399         if (tcsetattr (fd, TCSANOW, &newtio) < 0)
 400                 return FALSE;
 401
 402         if (custom_baud_rate == TRUE){
 403 #if defined(__linux__)
 404                 struct serial_struct ser;
 405
 406                 if (ioctl (fd, TIOCGSERIAL, &ser) < 0)
 407                 {
 408                         return FALSE;
 409                 }
 410
 411                 ser.custom_divisor = ser.baud_base / baud_rate;
 412                 ser.flags &= ~ASYNC_SPD_MASK;
 413                 ser.flags |= ASYNC_SPD_CUST;
 414
 415                 if (ioctl (fd, TIOCSSERIAL, &ser) < 0)
 416                 {
 417                         return FALSE;
 418                 }
 419 #elif __APPLE__
 420                 speed_t speed = baud_rate;
 421                 if (ioctl(fd, IOSSIOSPEED, &speed) == -1)
 422                         return FALSE;
 423 #else
 424                 /* Don't know how to set custom baud rate on this platform. */
 425                 return FALSE;
 426 #endif
 427         }
 428
 429         return TRUE;
 430 }
 431
 432
 433 static gint32
 434 get_signal_code (MonoSerialSignal signal)
 435 {
 436         switch (signal) {
 437                 case Cd:
 438                         return TIOCM_CAR;
 439                 case Cts:
 440                         return TIOCM_CTS;
 441                 case Dsr:
 442                         return TIOCM_DSR;
 443                 case Dtr:
 444                         return TIOCM_DTR;
 445                 case Rts:
 446                         return TIOCM_RTS;
 447                 default:
 448                         return 0;
 449         }
 450
 451         /* Not reached */
 452         return 0;
 453 }
 454
 455 static MonoSerialSignal
 456 get_mono_signal_codes (int signals)
 457 {
 458         MonoSerialSignal retval = NoneSignal;
 459
 460         if ((signals & TIOCM_CAR) != 0)
 461                 retval |= Cd;
 462         if ((signals & TIOCM_CTS) != 0)
 463                 retval |= Cts;
 464         if ((signals & TIOCM_DSR) != 0)
 465                 retval |= Dsr;
 466         if ((signals & TIOCM_DTR) != 0)
 467                 retval |= Dtr;
 468         if ((signals & TIOCM_RTS) != 0)
 469                 retval |= Rts;
 470
 471         return retval;
 472 }
 473
 474 MonoSerialSignal
 475 get_signals (int fd, gint32 *error)
 476 {
 477         int signals;
 478
 479         *error = 0;
 480
 481         if (ioctl (fd, TIOCMGET, &signals) == -1) {
 482                 *error = -1;
 483                 return NoneSignal;
 484         }
 485
 486         return get_mono_signal_codes (signals);
 487 }
 488
 489 gint32
 490 set_signal (int fd, MonoSerialSignal signal, gboolean value)
 491 {
 492         int signals, expected, activated;
 493
 494         expected = get_signal_code (signal);
 495         if (ioctl (fd, TIOCMGET, &signals) == -1)
 496                 return -1;
 497
 498         activated = (signals & expected) != 0;
 499         if (activated == value) /* Already set */
 500                 return 1;
 501
 502         if (value)
 503                 signals |= expected;
 504         else
 505                 signals &= ~expected;
 506
 507         if (ioctl (fd, TIOCMSET, &signals) == -1)
 508                 return -1;
 509
 510         return 1;
 511 }
 512
 513 int
 514 breakprop (int fd)
 515 {
 516         return tcsendbreak (fd, 0);
 517 }
 518
 519 gboolean
 520 poll_serial (int fd, gint32 *error, int timeout)
 521 {
 522         struct pollfd pinfo;
 523
 524         *error = 0;
 525
 526         pinfo.fd = fd;
 527         pinfo.events = POLLIN;
 528         pinfo.revents = 0;
 529
 530         while (poll (&pinfo, 1, timeout) == -1 && errno == EINTR) {
 531                 /* EINTR is an OK condition, we should not throw in the upper layer an IOException */
 532                 if (errno != EINTR){
 533                         *error = -1;
 534                         return FALSE;
 535                 }
 536         }
 537
 538         return (pinfo.revents & POLLIN) != 0 ? 1 : 0;
 539 }
 540
 541 /*
 542  * mono internals should not be used here.
 543  * this serial stuff needs to be implemented with icalls.
 544  * make this at least compile until the code is moved elsewhere
 545  * defined(linux) is wrong, too
 546  */
 547 void*
 548 list_serial_devices (void)
 549 {
 550         return NULL;
 551 }
 552
 553 #if 0
 554 MonoArray *
 555 list_serial_devices (void)
 556 {
 557         MonoArray *array;
 558 #if defined(linux)
 559         /* Linux serial files are of the form ttyS[0-9]+ */
 560         GSList *l, *list = NULL;
 561         GDir* dir = g_dir_open ("/dev", 0, NULL);
 562         const char *filename;
 563         int i = 0;
 564
 565         while ((filename = g_dir_read_name (dir))) {
 566                 if (filename) {
 567                         if (!strncmp (filename, "ttyS", 4))
 568                                 list = g_slist_append (list, g_strconcat ("/dev/", filename, NULL));
 569                 }
 570         }
 571
 572         g_dir_close (dir);
 573
 574         array = mono_array_new (mono_domain_get (), mono_get_string_class (), g_slist_length (list));
 575         for (l = list; l; l = l->next) {
 576                 mono_array_set (array, gpointer, i++, mono_string_new (mono_domain_get (), (char*)l->data));
 577                 g_free (l->data);
 578         }
 579
 580         g_slist_free (list);
 581
 582 #else
 583 #warning "list_serial_devices isn't ported to this OS"
 584 #endif
 585
 586         return array;
 587 }
 588 #endif
 589