aboutsummaryrefslogtreecommitdiff
path: root/comport/comport.c
blob: d9c3f255ec0cf721aae3c8314f28e9b3d2f46700 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
/* comport - PD external for unix/windows

 (c) 1998-2005  Winfried Ritsch (see LICENCE.txt)
 Institute for Electronic Music - Graz

 V 1.0 

*/

#include "m_pd.h"

#ifdef _MSC_VER
#pragma warning( disable : 4244 )
#pragma warning( disable : 4305 )
#endif

#ifdef _WIN32
#include <windows.h>
#include <commctrl.h>
#else
#include <sys/time.h>
#include <fcntl.h> 
#include <termios.h>               /* for TERMIO ioctl calls */
#include <unistd.h>
#include <glob.h>
#define HANDLE int
#define INVALID_HANDLE_VALUE -1
#endif /* _WIN32 */

#include <string.h>
#include <errno.h>
#include <stdio.h>


typedef struct comport
{
  t_object x_obj;

  long n;           /* the state of a last input */

  HANDLE comhandle;              /* holds the comport handle */

#ifdef _WIN32
	DCB dcb;                      /* holds the comm pars */
	DCB dcb_old;                  /* holds the comm pars */
	COMMTIMEOUTS old_timeouts; 
#else
	struct termios oldcom_termio;    /* save the old com config */
	struct termios com_termio;       /* for the new com config */
#endif
	t_symbol *serial_device;
	char serial_device_name[FILENAME_MAX];
  
  short comport;            /* holds the comport # */
  t_float baud;                /* holds the current baud rate */

  short rxerrors;             /* holds the rx line errors */

  t_clock *x_clock;
  int x_hit;
  double x_deltime;

  int verbose;

} t_comport;

#ifndef TRUE
#define TRUE    1
#define FALSE   0
#endif

#ifndef ON
#define ON      1
#define OFF     0
#endif

/*
    Serial Port Return Values
*/
#define NODATAAVAIL     -1
#define RXERRORS        -2
#define RXBUFOVERRUN    -4
#define TXBUFOVERRUN    -5

#define COMPORT_MAX 99

#ifdef _WIN32
static
long baudspeedbittable[] = 
{ 
  CBR_256000,
  CBR_128000,
  CBR_115200,
  CBR_57600,
  CBR_56000,
  CBR_38400,
  CBR_19200,
  CBR_14400,
  CBR_9600,
  CBR_4800,
  CBR_2400,
  CBR_1200,
  CBR_600,
  CBR_300,
  CBR_110
}; 

#else /* _WIN32 */

#ifdef  IRIX  
#define OPENPARAMS (O_RDWR|O_NDELAY|O_NOCTTY)
#define TIONREAD FIONREAD         /* re map the IOCTL function */
#define BAUDRATE_256000 -1
#define BAUDRATE_128000 -1
#define BAUDRATE_115200 -1
#define BAUDRATE_57600  -1
#define BAUDRATE_56000  -1
#define BAUDRATE_38400  B38400
#define BAUDRATE_14400  B19200 /* 14400 gibts nicht */
#else /* IRIX */
#define OPENPARAMS (O_RDWR|O_NDELAY|O_NOCTTY)
#define BAUDRATE_256000 -1
#define BAUDRATE_128000 -1
#define BAUDRATE_115200 B115200
#define BAUDRATE_57600  B57600
#define BAUDRATE_56000  B57600 /* 56000 gibts nicht */
#define BAUDRATE_38400  B38400
#define BAUDRATE_14400  B19200 /* 14400 gibts nicht */
#endif /* else IRIX */

static
short baudspeedbittable[] = 
{ 
  BAUDRATE_256000,  /* CPU SPECIFIC */
  BAUDRATE_128000,  /* CPU SPECIFIC */
  BAUDRATE_115200,  /* CPU SPECIFIC */
  BAUDRATE_57600,   /* CPU SPECIFIC */
  BAUDRATE_56000,
  BAUDRATE_38400,   /* CPU SPECIFIC */
  B19200,
  BAUDRATE_14400,
  B9600,
  B4800,
  B2400,
  B1200,
  B600,
  B300,
  B110
}; 

struct timeval null_tv;

#endif /* else _WIN32 */


#define BAUDRATETABLE_LEN 15

static
long baudratetable[] = 
{ 
  256000L,
  128000L,
  115200L,
  57600L,
  56000L,
  38400L,
  19200L,
  14400L,
  9600L,
  4800L,
  2400L,
  1200L,
  600L,
  300L,
  110L
};    /* holds the baud rate selections */

t_class *comport_class;

/* --------- sys independend serial setup helpers ---------------- */

static long get_baud_ratebits(t_float *baud)
{
 int i = 0;

  while(i < BAUDRATETABLE_LEN && baudratetable[i] > *baud)
    i++;
  
  /* nearest Baudrate finding */
  if(i==BAUDRATETABLE_LEN ||  baudspeedbittable[i] < 0){
    post("*Warning* The baud rate %d is not suported or out of range, using 9600\n",*baud);
    i = 7;
  }
  *baud =  baudratetable[i];

  return baudspeedbittable[i];
}


/* ------------ sys dependend serial setup helpers ---------------- */


/* --------------------- NT ------------------------------------ */

#ifdef _WIN32


static float set_baudrate(t_comport *x,t_float baud)
{
  x->dcb.BaudRate = get_baud_ratebits(&baud);

  return baud;
}

/* bits are 5,6,7,8(default) */

static float set_bits(t_comport *x, int nr)
{

  if(nr < 4 && nr > 8)
    nr = 8;

 /*  number of bits/byte, 4-8  */
  return x->dcb.ByteSize = nr;
}


/* 1 ... Parity even, -1 parity odd , 0 (default) no parity */
static float set_parity(t_comport *x,int n)
{
  switch(n){
  case 1:
    x->dcb.fParity = TRUE; /*  enable parity checking */
    x->dcb.Parity = 2;     /*  0-4=no,odd,even,mark,space  */
    return 1;

  case -1:
    x->dcb.fParity = TRUE; /*  enable parity checking */
    x->dcb.Parity = 1;     /*  0-4=no,odd,even,mark,space  */
    return -1;

  default:
    x->dcb.fParity = FALSE; /*  enable parity checking */
    x->dcb.Parity = 0;     /*  0-4=no,odd,even,mark,space  */
  }
  return 0;
}


/* aktivate second stop bit with 1, 0(default)*/
static float set_stopflag(t_comport *x, int nr)
{
  if(nr == 1){
    x->dcb.StopBits = 1;             /*  0,1,2 = 1, 1.5, 2  */
    return 1;
  }
  else
    x->dcb.StopBits = 0;             /*  0,1,2 = 1, 1.5, 2  */

  return 0;
}

/* never testet */
static int set_ctsrts(t_comport *x, int nr)
{
  if(nr == 1){
  x->dcb.fOutxCtsFlow = TRUE;      /*  CTS output flow control  */
  x->dcb.fRtsControl = RTS_CONTROL_ENABLE;       /*  RTS flow control  */
  return 1;
  }
  x->dcb.fOutxCtsFlow = FALSE;      /*  CTS output flow control  */
  x->dcb.fRtsControl = RTS_CONTROL_DISABLE;       /*  RTS flow control  */
  return 0;
}

static int set_xonxoff(t_comport *x, int nr)
{
  /*   x->dcb.fTXContinueOnXoff = FALSE;  XOFF continues Tx  */

  if(nr == 1){ 
    x->dcb.fOutX  = TRUE;           /*  XON/XOFF out flow control  */
    x->dcb.fInX  = TRUE;             /*  XON/XOFF in flow control */
    return 1;
  }

  x->dcb.fOutX  = FALSE;           /*  XON/XOFF out flow control  */
  x->dcb.fInX  = FALSE;             /*  XON/XOFF in flow control */
  return 0;
}


static int set_serial(t_comport *x)
{

 if (SetCommState(x->comhandle, &(x->dcb)))
   return 1;

 return 0;
}

static HANDLE open_serial(unsigned int com_num, t_comport *x)
{
  HANDLE fd;
  COMMTIMEOUTS timeouts;
  char buffer[MAX_PATH];
  float *baud = &(x->baud);
  
  if(com_num < 1 || com_num >= COMPORT_MAX) {
	  post("comport open %d, baud %d not valid (args: [portnum] [baud])",com_num,*baud);
	  return INVALID_HANDLE_VALUE;
  }
  
  sprintf(buffer, "%s%d", x->serial_device_name, com_num);
  x->serial_device = gensym(buffer);
  post("Opening %s",x->serial_device->s_name);
  fd = CreateFile( x->serial_device->s_name,  
		   GENERIC_READ | GENERIC_WRITE, 
		   0, 
		   0, 
		   OPEN_EXISTING,
		   FILE_FLAG_OVERLAPPED,
		   0);

  if(fd == INVALID_HANDLE_VALUE)
    {
      post("** ERROR ** could not open device %s:\n failure(%d): %s\n",
	   x->serial_device->s_name,errno,strerror(errno));
      return INVALID_HANDLE_VALUE;
    }

  /*   Save the Current Port Configuration  */

  if (!GetCommState(fd, &(x->dcb_old))){
    post("** ERROR ** could not get old dcb of device %s\n", 
	 x->serial_device->s_name);

    CloseHandle(fd); 
    return INVALID_HANDLE_VALUE;
  }

  memset(&(x->dcb), sizeof(DCB), 0);

  if (!GetCommState(fd, &(x->dcb))){
    post("** ERROR ** could not get new dcb of device %s\n", 
	 x->serial_device->s_name);

    CloseHandle(fd); 
    return INVALID_HANDLE_VALUE;
  }


  x->dcb.fBinary = TRUE;          /*  binary mode, no EOF check  */

  /*   x->dcb.fOutxDsrFlow = FALSE;       DSR output flow control  */
  /*   x->dcb.fDtrControl = DTR_CONTROL_DISABLE;        DTR flow control type  */

  /*   x->dcb.fDsrSensitivity = FALSE;    DSR sensitivity  */

  x->dcb.fErrorChar = FALSE;       /*  enable error replacement  */
  /*    x->dcb.fNull = FALSE;             enable null stripping  */

  /*     DWORD x->dcb.fAbortOnError:1;      abort reads/writes on error  */

  /*    char x->dcb.XonChar;               Tx and Rx XON character  */
  /*    char x->dcb.XoffChar;              Tx and Rx XOFF character  */
  /*    char x->dcb.ErrorChar;             error replacement character  */
  /*    char x->dcb.EofChar;               end of input character  */
  /*    char x->dcb.EvtChar;               received event character  */

  set_bits(x,8);      /* CS8 */
  set_stopflag(x,0);  /* ~CSTOPB */
  set_ctsrts(x,0);  /* ~CRTSCTS;*/
  set_xonxoff(x,0); /* (IXON | IXOFF | IXANY) */
  set_baudrate(x,*baud);

  x->comhandle = fd;

  if(set_serial(x))
  {
	  post("[comport] opened serial line device %d (%s)\n",
		   com_num,x->serial_device->s_name);
  }
  else 
  {
	  error("[comport] ** ERROR ** could not set params to control dcb of device %s\n",
		   x->serial_device->s_name);
      CloseHandle(fd); 
      return INVALID_HANDLE_VALUE;
    }
  

  
  if (!GetCommTimeouts(fd, &(x->old_timeouts))){
	  post("[comport] Couldn't get old timeouts for serial device");
  };

  /* setting new timeouts for read to immidiatly return */
  timeouts.ReadIntervalTimeout = MAXDWORD; 
  timeouts.ReadTotalTimeoutMultiplier = 0;
  timeouts.ReadTotalTimeoutConstant = 0;
  timeouts.WriteTotalTimeoutMultiplier = 0;
  timeouts.WriteTotalTimeoutConstant = 0;

  if (!SetCommTimeouts(fd, &timeouts)){
  	  post("Couldnt set timeouts for serial device");
	  return INVALID_HANDLE_VALUE;	
  };

  
  return fd;
}

static HANDLE close_serial(t_comport *x)
{
  if(x->comhandle != INVALID_HANDLE_VALUE){

    if (!SetCommState(x->comhandle, &(x->dcb_old)) )
      {
	post("** ERROR ** could not reset params to DCB of device %s\n",
	     x->serial_device->s_name);
      }

    if (!SetCommTimeouts(x->comhandle, &(x->old_timeouts))){
      post("Couldnt reset old_timeouts for serial device");
    };
    CloseHandle(x->comhandle); 
  }

  return INVALID_HANDLE_VALUE;
}


static int write_serial(t_comport *x, unsigned char serial_byte)
{
  OVERLAPPED osWrite = {0};
  DWORD dwWritten;
  DWORD dwToWrite = 1;
  DWORD dwErr;
  char cErr[100];
  
  osWrite.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
  if (osWrite.hEvent == NULL)
  {
	  post("Couldn't create event. Transmission aborted.");
	  return 0;
  }
  
  
  if (!WriteFile(x->comhandle, &serial_byte, dwToWrite, &dwWritten, &osWrite)) 
  {
	  dwErr = GetLastError();
	  if (dwErr != ERROR_IO_PENDING) 
	  {
		  sprintf(cErr, "WriteFile error: %d", (int)dwErr);
		  post(cErr);
		  return 0; 
	  }  
  }
  CloseHandle(osWrite.hEvent);
  return 1;
}

#else /* NT */
/* ----------------- POSIX - UNIX ------------------------------ */


static float set_baudrate(t_comport *x,t_float baud)
{
  struct termios *tio = &(x->com_termio);

  long baudbits = get_baud_ratebits(&baud);

  cfsetispeed(tio, baudbits);
  cfsetospeed(tio, baudbits);

  return baud;
}

/* bits are 5,6,7,8(default) */

static float set_bits(t_comport *x, int nr)
{
  struct termios *tio = &(x->com_termio);
  tio->c_cflag &= ~CSIZE;
  switch(nr){
  case 5:     tio->c_cflag |= CS5; return 5;
  case 6:     tio->c_cflag |= CS6; return 6;
  case 7:     tio->c_cflag |= CS7; return 7;
  default:    tio->c_cflag |= CS8; 
  }
  return 8;
}


/* 1 ... Parity even, -1 parity odd , 0 (default) no parity */
static float set_parity(t_comport *x,int n)
{
  struct termios *tio = &(x->com_termio);

  switch(n){
  case 1:
    tio->c_cflag |= PARENB;  tio->c_cflag &= ~PARODD; return 1;
  case -1:
    tio->c_cflag |= PARENB | PARODD; return -1;
  default:
    tio->c_cflag &= ~PARENB;
  }
  return 0;
}


/* aktivate second stop bit with 1, 0(default)*/
static float set_stopflag(t_comport *x, int nr)
{
  struct termios *tio = &(x->com_termio);

  if(nr == 1){
    tio->c_cflag |= CSTOPB;
    return 1;
  }
  else
    tio->c_cflag &= ~CSTOPB;
  return 0;
}

/* never testet */
static int set_ctsrts(t_comport *x, int nr)
{
  struct termios *tio = &(x->com_termio);

  if(nr == 1){
    tio->c_cflag |= CRTSCTS;
    return 1;
  }
  tio->c_cflag &= ~CRTSCTS;
  return 0;
}

static int set_xonxoff(t_comport *x, int nr)
{
  struct termios *tio = &(x->com_termio);

  if(nr == 1){ 
    tio->c_iflag |= (IXON | IXOFF | IXANY); 
    return 1;
  }

  tio->c_iflag &= ~IXON & ~IXOFF &  ~IXANY;
  return 0;
}

static int open_serial(unsigned int com_num, t_comport *x)
{
  HANDLE fd;
  struct termios *old = &(x->oldcom_termio);
  struct termios *new = &(x->com_termio);
  float *baud = &(x->baud);
  glob_t glob_buffer;

  if(com_num >= COMPORT_MAX) {
	  post("[comport] ** WARNING ** port %d not valid, must be between 0 and %d",
		   com_num, COMPORT_MAX - 1);
	  return INVALID_HANDLE_VALUE;
  }
//  post("[comport] globbing %s",x->serial_device_name);
  /* get the device path based on the com# and the glob pattern */
  switch( glob( x->serial_device_name, 0, NULL, &glob_buffer ) )
  {
  case GLOB_NOSPACE: 
	  error("[comport] out of memory for \"%s\"",x->serial_device_name); 
		  break;
  case GLOB_ABORTED: 
	  error("[comport] aborted \"%s\"",x->serial_device_name); 
		  break;
  case GLOB_NOMATCH: 
	  error("[comport] no serial devices found for \"%s\"",x->serial_device_name); 
	  break;
  }
  if(com_num < glob_buffer.gl_pathc)
  {
	  x->serial_device = gensym(glob_buffer.gl_pathv[com_num]);
  }
  else
  {
	  post("[comport] ** WARNING ** port #%d does not exist! (max == %d)",
		   com_num,glob_buffer.gl_pathc - 1);
	  return INVALID_HANDLE_VALUE;
  }
  globfree( &(glob_buffer) );

  if((fd = open(x->serial_device->s_name, OPENPARAMS)) == INVALID_HANDLE_VALUE)
    {
		error("[comport] ** ERROR ** could not open device %s:\n failure(%d): %s\n",
			  x->serial_device->s_name,errno,strerror(errno));
		return INVALID_HANDLE_VALUE;
    }

  /* set no wait on any operation */
  fcntl(fd, F_SETFL, FNDELAY);
  
  /*   Save the Current Port Configuration  */
  if(tcgetattr(fd, old) == -1 || tcgetattr(fd, new) == -1){
    error("[comport] ** ERROR ** could not get termios-structure of device %s\n",
	 x->serial_device->s_name);
    close(fd);
    return INVALID_HANDLE_VALUE;
  }
  
  
  /* Setupt the new port configuration...NON-CANONICAL INPUT MODE
	 .. as defined in termios.h
  */

  /* enable input and ignore modem controls */
  new->c_cflag |= (CREAD | CLOCAL);

  /* always nocanonical, this means raw i/o no terminal */
  new->c_lflag &= ~(ICANON | ECHO | ECHOE | ISIG);

  /* no post processing */
  new->c_oflag &= ~OPOST;

  /* setup to return after 0 seconds 
    ..if no characters are received 
    TIME units are assumed to be 0.1 secs */
  /* not needed anymore ??? in new termios in linux
  new->c_cc[VMIN] = 0;     
  new->c_cc[VTIME] = 0;   
  */
  
  /* defaults, see input */

  set_bits(x,8);      /* CS8 */
  set_stopflag(x,0);  /* ~CSTOPB */
  set_ctsrts(x,0);  /* ~CRTSCTS;*/
  set_xonxoff(x,0); /* (IXON | IXOFF | IXANY) */
  set_baudrate(x,*baud);
  
  if(tcsetattr(fd, TCSAFLUSH, new) != -1)
	 {
		 post("[comport] opened serial line device %d (%s)\n",
			  com_num,x->serial_device->s_name);
	 }
  else 
	 {
		error("[comport] ** ERROR ** could not set params to ioctl of device %s\n",
			  x->serial_device->s_name);
		close(fd);
		return INVALID_HANDLE_VALUE;
	 }

  return fd;
}


static int close_serial(t_comport *x)
{
  struct termios *tios = &(x->com_termio);
  HANDLE fd = x->comhandle;

   if(fd != INVALID_HANDLE_VALUE){
    tcsetattr(fd, TCSANOW, tios);
    close(fd);
   }
   return INVALID_HANDLE_VALUE;
}


static int set_serial(t_comport *x)
{
  if(tcsetattr(x->comhandle, TCSAFLUSH, &(x->com_termio)) == -1)
    return 0;
  return 1;
}

static int write_serial(t_comport *x, unsigned char  serial_byte)
{

  return write(x->comhandle,(char *) &serial_byte,1);

  /* flush pending I/O chars */
  /* but nowadays discards them ;-(
  else{
      ioctl(x->comhandle,TCFLSH,TCOFLUSH);
  }
  */  
}


#endif /* else NT */


/* ------------------- serial pd methods --------------------------- */
static void comport_pollintervall(t_comport *x, t_floatarg g)
{
    if (g < 1) g = 1;
    x->x_deltime = g;
}

static void comport_tick(t_comport *x)
{
  int err;
  HANDLE fd = x->comhandle;

  x->x_hit = 0;


  if(fd == INVALID_HANDLE_VALUE) return;
  
  /* while there are bytes, read them and send them out, ignore errors */
#ifdef _WIN32
  {
    unsigned char serial_byte[1000];
    DWORD dwRead;
    OVERLAPPED osReader = {0};
    DWORD dwX;
    
    err = 0;
    
    osReader.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
    if(ReadFile(x->comhandle, serial_byte, 1000, &dwRead, &osReader))
      {
	if(dwRead > 0)
	  {	
	    for(dwX=0;dwX<dwRead;dwX++)
	      {
		outlet_float(x->x_obj.ob_outlet, (t_float) serial_byte[dwX]);
	      }
	  }
      }
    else
      {
	err = -1;
      }
    CloseHandle(osReader.hEvent);
  }
#else
  {
    unsigned char serial_byte;
    fd_set com_rfds;  	 
    FD_ZERO(&com_rfds);
    FD_SET(fd,&com_rfds);

    while((err=select(fd+1,&com_rfds,NULL,NULL,&null_tv)) > 0) {

      err = read(fd,(char *) &serial_byte,1); 

      /*  while(    (err = read(fd,(char *) &serial_byte,1)) > 0){ */
      outlet_float(x->x_obj.ob_outlet, (t_float) serial_byte);

    };
  }
#endif 

  if(err < 0){                  /* if an readerror detected */
    if(x->rxerrors == 0)            /* post it once */
      post("RXERRORS on serial line\n");
    x->rxerrors = 1;                /* remember */
  }

  if (!x->x_hit) clock_delay(x->x_clock, 1);
}

static void comport_float(t_comport *x, t_float f)
{
  unsigned char serial_byte = ((int) f) & 0xFF; /* brutal conv */

  if (write_serial(x,serial_byte) != 1)
    {
	 post("Write error, maybe TX-OVERRUNS on serial line");
    }
}

static void *comport_new(t_floatarg com_num, t_floatarg fbaud) 
{
  t_comport test;
  t_comport *x;
  HANDLE fd;

/* for UNIX, this is a glob pattern for matching devices  */
#ifdef _WIN32
  const char *serial_device_name = "COM";
#else
# ifdef __APPLE__
  const char *serial_device_name = "/dev/tty.*";
# else
#  ifdef IRIX
  const char *serial_device_name = "/dev/ttyd*";
#  else
  const char *serial_device_name = "/dev/tty[SU]*";
#  endif /* IRIX */
# endif /* __APPLE__ */
#endif /* _WIN32 */


/*	 Open the Comport for RD and WR and get a handle */
  strncpy(test.serial_device_name,serial_device_name,strlen(serial_device_name)+1);
  test.baud = fbaud;
  fd = open_serial((unsigned int)com_num,&test);

  /* Now  nothing really bad could happen so we create the class */
  x = (t_comport *)pd_new(comport_class);

  x->comport = (short)com_num;
  strncpy(x->serial_device_name,serial_device_name,strlen(serial_device_name)+1);
  x->baud = test.baud;
  x->comhandle = fd;           /* holds the comport handle */

  if(fd == INVALID_HANDLE_VALUE ){
    /* postings in open routine */
	  post("[comport] invalid handle for %s",x->serial_device_name);
  }
  else {
#ifdef _WIN32
  memcpy(&(test.dcb_old),&(x->dcb_old),sizeof(DCB));    /*  save the old com config  */
  memcpy(&(test.dcb),&(x->dcb),sizeof(DCB));       /*  for the new com config  */
#else  
  /* save the old com and new com config */
  bcopy(&(test.oldcom_termio),&(x->oldcom_termio),sizeof(struct termios));    
  bcopy(&(test.com_termio),&(x->com_termio),sizeof(struct termios));       
#endif
  }

  x->rxerrors = 0;             /* holds the rx line errors */

  outlet_new(&x->x_obj, &s_float);

  x->x_hit = 0;
  x->x_deltime = 1;
  x->x_clock = clock_new(x, (t_method)comport_tick);

  clock_delay(x->x_clock, x->x_deltime);

  x->verbose = 0;

  return x;
}


static void
comport_free(t_comport *x)
{
  post("free serial...");

  clock_unset(x->x_clock);
  clock_free(x->x_clock);
  x->comhandle = close_serial(x);
}

/* ---------------- use serial settings ------------- */

static void comport_baud(t_comport *x,t_floatarg f)
{
  if(f == x->baud){
    post("baudrate already %f\n",x->baud);
    return;
  }

  x->baud = set_baudrate(x,f);

  if(x->comhandle == INVALID_HANDLE_VALUE)return;

  if(set_serial(x) == 0){
    error("[comport] ** ERROR ** could not set baudrate of device %s\n",
	 x->serial_device->s_name);
  }
  else post("set baudrate of %s to %f\n",x->serial_device->s_name,x->baud);
}

static void comport_bits(t_comport *x,t_floatarg f)
{
  f = set_bits(x,f);

  if(x->comhandle == INVALID_HANDLE_VALUE)return;

  if(set_serial(x) == 0){
    error("[comport] ** ERROR ** could not set bits of device %s\n",
	 x->serial_device->s_name);
  }
  else post("set bits of %s to %f\n",x->serial_device->s_name,f);
}


static void comport_parity(t_comport *x,t_floatarg f)
{
  f = set_parity(x,f);

  if(x->comhandle == INVALID_HANDLE_VALUE)return;

  if(set_serial(x) == 0){
    error("[comport] ** ERROR ** could not set extra paritybit of device %s\n",
	 x->serial_device->s_name);
  }
  else post("[comport] set extra paritybit of %s to %f\n",x->serial_device->s_name,f);
}

static void comport_stopbit(t_comport *x,t_floatarg f)
{
  f = set_stopflag(x,f);

  if(x->comhandle == INVALID_HANDLE_VALUE)return;

  if(set_serial(x) == 0){
    error("[comport] ** ERROR ** could not set extra stopbit of device %s\n",
	 x->serial_device->s_name);
  }
  else post("[comport] set extra stopbit of %s to %f\n",x->serial_device->s_name,f);
}

static void comport_rtscts(t_comport *x,t_floatarg f)
{
  f = set_ctsrts(x,f);

  if(x->comhandle == INVALID_HANDLE_VALUE)return;

  if(set_serial(x) == 0){
    error("[comport] ** ERROR ** could not set rts_cts of device %s\n",
	 x->serial_device->s_name);
  }
  else post("[comport] set rts-cts of %s to %f\n",x->serial_device->s_name,f);
}

static void comport_xonxoff(t_comport *x,t_floatarg f)
{
  f = set_xonxoff(x,f);

  if(x->comhandle == INVALID_HANDLE_VALUE)return;

  if(set_serial(x) == 0){
    error("[comport] ** ERROR ** could not set xonxoff of device %s\n",
	 x->serial_device->s_name);
  }
  else if(x->verbose > 0)
	post("[comport] set xonxoff of %s to %f\n",x->serial_device->s_name,f);
}

static void comport_close(t_comport *x)
{
  clock_unset(x->x_clock);
  x->x_hit = 1;
  x->comhandle = close_serial(x);
}

static void comport_open(t_comport *x, t_floatarg f)
{
  if(x->comhandle != INVALID_HANDLE_VALUE)
    comport_close(x);


  x->comhandle = open_serial(f,x);

  clock_delay(x->x_clock, x->x_deltime);
}

/* 
   dangerous but if you really have some stupid devicename ... 
   you can open any file on systems if suid is set on pd be careful
*/

static void comport_devicename(t_comport *x, t_symbol *s)
{
  if(x->comport >= 0 && x->comport < COMPORT_MAX){
    x->serial_device->s_name = s->s_name;   
    if(x->verbose > 0)
        post("[comport] %d: set devicename %s",x->comport,x->serial_device->s_name);
  }
  else if(x->verbose > 0)
     post("[comport] %d: could not set devicename %s",x->comport,s->s_name);

}

static void comport_print(t_comport *x, t_symbol *s, int argc, t_atom *argv)
{
  static char buf[256];
  char *pch = buf;

  while(argc--) {
    atom_string(argv++, buf, 255);
    while(*pch != 0) {
      write_serial(x, *pch++);
    }
    if(argc > 0) {
      write_serial(x, ' ');
    }
  }
}
/* ---------------- HELPER ------------------------- */
static void comport_verbose(t_comport *x, t_floatarg f)
{
  x->verbose = f;
  if(f >  0)
	post("[comport] verbose is on: %d", (int) f);
}


static void comport_help(t_comport *x)
{
	post("[comport] serial port %d (baud %f):",x->comport,x->baud);
	if(x->comport >= 0 && x->comport < COMPORT_MAX){
    		post("\tdevicename: %s",x->serial_device->s_name);
	  }

	post("  Methods:");
	post("   baud <baud>     ... set baudrate to nearest possible baud\n"
             "   bits <bits>     ... set number of bits (7 or 8)\n"
             "   stopbit <0|1>   ... set off|on stopbit\n"
             "   rtscts <0|1>    ... set rts/cts off|on\n"
             "   parity <0|1>    ... set parity off|on\n"
             "   xonxoff <0|1>   ... set xon/xoff off|on\n"
             "   close           ... close device\n"
             "   open <num>      ... open device number num\n"
             "   devicename <d>  ... set device name to s (eg. /dev/ttyS8)\n"
             "   print <list>    ... print list of atoms on serial\n"
             "   pollintervall <t> ... set poll ibntervall to t ticks\n"
             "   verbose <level> ... for debug set verbosity to level\n"
             "   help            ... post this help");
}

/* ---------------- SETUP OBJECTS ------------------ */

void comport_setup(void)
{
  comport_class 
	 = class_new(gensym("comport"), (t_newmethod)comport_new,
					 (t_method)comport_free, sizeof(t_comport), 
					 0, A_DEFFLOAT, A_DEFFLOAT, 0);

  class_addfloat(comport_class, (t_method)comport_float);

  /*
    class_addbang(comport_class, comport_bang
  */  
  class_addmethod(comport_class, (t_method)comport_baud, gensym("baud"),A_FLOAT, 0); 
  
  class_addmethod(comport_class, (t_method)comport_bits, gensym("bits"), A_FLOAT, 0);
  class_addmethod(comport_class, (t_method)comport_stopbit, gensym("stopbit"), A_FLOAT, 0);
  class_addmethod(comport_class, (t_method)comport_rtscts, gensym("rtscts"), A_FLOAT, 0);
  class_addmethod(comport_class, (t_method)comport_parity, gensym("parity"), A_FLOAT, 0);
  class_addmethod(comport_class, (t_method)comport_xonxoff, gensym("xonxoff"), A_FLOAT, 0);
  class_addmethod(comport_class, (t_method)comport_close, gensym("close"), 0);
  class_addmethod(comport_class, (t_method)comport_open, gensym("open"), A_FLOAT, 0);
  class_addmethod(comport_class, (t_method)comport_devicename, gensym("devicename"), A_SYMBOL, 0);
  class_addmethod(comport_class, (t_method)comport_print, gensym("print"), A_GIMME, 0);
  class_addmethod(comport_class, (t_method)comport_pollintervall, gensym("pollintervall"), A_FLOAT, 0);

  class_addmethod(comport_class, (t_method)comport_verbose, gensym("verbose"), A_FLOAT, 0);
  class_addmethod(comport_class, (t_method)comport_help, gensym("help"), 0);

#ifndef _WIN32
  null_tv.tv_sec = 0; /* no wait */
  null_tv.tv_usec = 0;
#endif /* NOT _WIN32 */
  post("comport - PD external for unix/windows\n"
       "LGPL 1998-2005,  Winfried Ritsch and others (see LICENCE.txt)\n"
       "Institute for Electronic Music - Graz");
}