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