-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
modbus-rtu.c
1071 lines (940 loc) · 31.7 KB
/
modbus-rtu.c
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
/*
* Copyright © 2001-2011 Stéphane Raimbault <stephane.raimbault@gmail.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <fcntl.h>
#include <string.h>
#ifndef _MSC_VER
#include <unistd.h>
#endif
#include <assert.h>
#include "modbus-private.h"
#include "modbus-rtu.h"
#include "modbus-rtu-private.h"
#if HAVE_DECL_TIOCSRS485 || HAVE_DECL_TIOCM_RTS
#include <sys/ioctl.h>
#endif
#if HAVE_DECL_TIOCSRS485
#include <linux/serial.h>
#endif
/* Table of CRC values for high-order byte */
static const uint8_t table_crc_hi[] = {
0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40,
0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1,
0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41,
0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1,
0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40,
0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1,
0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40,
0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40,
0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40,
0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40,
0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1,
0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
0x80, 0x41, 0x00, 0xC1, 0x81, 0x40
};
/* Table of CRC values for low-order byte */
static const uint8_t table_crc_lo[] = {
0x00, 0xC0, 0xC1, 0x01, 0xC3, 0x03, 0x02, 0xC2, 0xC6, 0x06,
0x07, 0xC7, 0x05, 0xC5, 0xC4, 0x04, 0xCC, 0x0C, 0x0D, 0xCD,
0x0F, 0xCF, 0xCE, 0x0E, 0x0A, 0xCA, 0xCB, 0x0B, 0xC9, 0x09,
0x08, 0xC8, 0xD8, 0x18, 0x19, 0xD9, 0x1B, 0xDB, 0xDA, 0x1A,
0x1E, 0xDE, 0xDF, 0x1F, 0xDD, 0x1D, 0x1C, 0xDC, 0x14, 0xD4,
0xD5, 0x15, 0xD7, 0x17, 0x16, 0xD6, 0xD2, 0x12, 0x13, 0xD3,
0x11, 0xD1, 0xD0, 0x10, 0xF0, 0x30, 0x31, 0xF1, 0x33, 0xF3,
0xF2, 0x32, 0x36, 0xF6, 0xF7, 0x37, 0xF5, 0x35, 0x34, 0xF4,
0x3C, 0xFC, 0xFD, 0x3D, 0xFF, 0x3F, 0x3E, 0xFE, 0xFA, 0x3A,
0x3B, 0xFB, 0x39, 0xF9, 0xF8, 0x38, 0x28, 0xE8, 0xE9, 0x29,
0xEB, 0x2B, 0x2A, 0xEA, 0xEE, 0x2E, 0x2F, 0xEF, 0x2D, 0xED,
0xEC, 0x2C, 0xE4, 0x24, 0x25, 0xE5, 0x27, 0xE7, 0xE6, 0x26,
0x22, 0xE2, 0xE3, 0x23, 0xE1, 0x21, 0x20, 0xE0, 0xA0, 0x60,
0x61, 0xA1, 0x63, 0xA3, 0xA2, 0x62, 0x66, 0xA6, 0xA7, 0x67,
0xA5, 0x65, 0x64, 0xA4, 0x6C, 0xAC, 0xAD, 0x6D, 0xAF, 0x6F,
0x6E, 0xAE, 0xAA, 0x6A, 0x6B, 0xAB, 0x69, 0xA9, 0xA8, 0x68,
0x78, 0xB8, 0xB9, 0x79, 0xBB, 0x7B, 0x7A, 0xBA, 0xBE, 0x7E,
0x7F, 0xBF, 0x7D, 0xBD, 0xBC, 0x7C, 0xB4, 0x74, 0x75, 0xB5,
0x77, 0xB7, 0xB6, 0x76, 0x72, 0xB2, 0xB3, 0x73, 0xB1, 0x71,
0x70, 0xB0, 0x50, 0x90, 0x91, 0x51, 0x93, 0x53, 0x52, 0x92,
0x96, 0x56, 0x57, 0x97, 0x55, 0x95, 0x94, 0x54, 0x9C, 0x5C,
0x5D, 0x9D, 0x5F, 0x9F, 0x9E, 0x5E, 0x5A, 0x9A, 0x9B, 0x5B,
0x99, 0x59, 0x58, 0x98, 0x88, 0x48, 0x49, 0x89, 0x4B, 0x8B,
0x8A, 0x4A, 0x4E, 0x8E, 0x8F, 0x4F, 0x8D, 0x4D, 0x4C, 0x8C,
0x44, 0x84, 0x85, 0x45, 0x87, 0x47, 0x46, 0x86, 0x82, 0x42,
0x43, 0x83, 0x41, 0x81, 0x80, 0x40
};
/* Define the slave ID of the remote device to talk in master mode or set the
* internal slave ID in slave mode */
static int _modbus_set_slave(modbus_t *ctx, int slave)
{
/* Broadcast address is 0 (MODBUS_BROADCAST_ADDRESS) */
if (slave >= 0 && slave <= 247) {
ctx->slave = slave;
} else {
errno = EINVAL;
return -1;
}
return 0;
}
/* Builds a RTU request header */
static int _modbus_rtu_build_request_basis(modbus_t *ctx, int function,
int addr, int nb,
uint8_t *req)
{
assert(ctx->slave != -1);
req[0] = ctx->slave;
req[1] = function;
req[2] = addr >> 8;
req[3] = addr & 0x00ff;
req[4] = nb >> 8;
req[5] = nb & 0x00ff;
return _MODBUS_RTU_PRESET_REQ_LENGTH;
}
/* Builds a RTU response header */
static int _modbus_rtu_build_response_basis(sft_t *sft, uint8_t *rsp)
{
/* In this case, the slave is certainly valid because a check is already
* done in _modbus_rtu_listen */
rsp[0] = sft->slave;
rsp[1] = sft->function;
return _MODBUS_RTU_PRESET_RSP_LENGTH;
}
static uint16_t crc16(uint8_t *buffer, uint16_t buffer_length)
{
uint8_t crc_hi = 0xFF; /* high CRC byte initialized */
uint8_t crc_lo = 0xFF; /* low CRC byte initialized */
unsigned int i; /* will index into CRC lookup */
/* pass through message buffer */
while (buffer_length--) {
i = crc_hi ^ *buffer++; /* calculate the CRC */
crc_hi = crc_lo ^ table_crc_hi[i];
crc_lo = table_crc_lo[i];
}
return (crc_hi << 8 | crc_lo);
}
static int _modbus_rtu_prepare_response_tid(const uint8_t *req, int *req_length)
{
(*req_length) -= _MODBUS_RTU_CHECKSUM_LENGTH;
/* No TID */
return 0;
}
static int _modbus_rtu_send_msg_pre(uint8_t *req, int req_length)
{
uint16_t crc = crc16(req, req_length);
req[req_length++] = crc >> 8;
req[req_length++] = crc & 0x00FF;
return req_length;
}
#if defined(_WIN32)
/* This simple implementation is sort of a substitute of the select() call,
* working this way: the win32_ser_select() call tries to read some data from
* the serial port, setting the timeout as the select() call would. Data read is
* stored into the receive buffer, that is then consumed by the win32_ser_read()
* call. So win32_ser_select() does both the event waiting and the reading,
* while win32_ser_read() only consumes the receive buffer.
*/
static void win32_ser_init(struct win32_ser *ws) {
/* Clear everything */
memset(ws, 0x00, sizeof(struct win32_ser));
/* Set file handle to invalid */
ws->fd = INVALID_HANDLE_VALUE;
}
/* FIXME Try to remove length_to_read -> max_len argument, only used by win32 */
static int win32_ser_select(struct win32_ser *ws, int max_len,
struct timeval *tv) {
COMMTIMEOUTS comm_to;
unsigned int msec = 0;
/* Check if some data still in the buffer to be consumed */
if (ws->n_bytes > 0) {
return 1;
}
/* Setup timeouts like select() would do.
FIXME Please someone on Windows can look at this?
Does it possible to use WaitCommEvent?
When tv is NULL, MAXDWORD isn't infinite!
*/
if (tv == NULL) {
msec = MAXDWORD;
} else {
msec = tv->tv_sec * 1000 + tv->tv_usec / 1000;
if (msec < 1)
msec = 1;
}
comm_to.ReadIntervalTimeout = msec;
comm_to.ReadTotalTimeoutMultiplier = 0;
comm_to.ReadTotalTimeoutConstant = msec;
comm_to.WriteTotalTimeoutMultiplier = 0;
comm_to.WriteTotalTimeoutConstant = 1000;
SetCommTimeouts(ws->fd, &comm_to);
/* Read some bytes */
if ((max_len > PY_BUF_SIZE) || (max_len < 0)) {
max_len = PY_BUF_SIZE;
}
if (ReadFile(ws->fd, &ws->buf, max_len, &ws->n_bytes, NULL)) {
/* Check if some bytes available */
if (ws->n_bytes > 0) {
/* Some bytes read */
return 1;
} else {
/* Just timed out */
return 0;
}
} else {
/* Some kind of error */
return -1;
}
}
static int win32_ser_read(struct win32_ser *ws, uint8_t *p_msg,
unsigned int max_len) {
unsigned int n = ws->n_bytes;
if (max_len < n) {
n = max_len;
}
if (n > 0) {
memcpy(p_msg, ws->buf, n);
}
ws->n_bytes -= n;
return n;
}
#endif
static void _modbus_rtu_ioctl_rts(int fd, int on)
{
#if HAVE_DECL_TIOCM_RTS
int flags;
ioctl(fd, TIOCMGET, &flags);
if (on) {
flags |= TIOCM_RTS;
} else {
flags &= ~TIOCM_RTS;
}
ioctl(fd, TIOCMSET, &flags);
#endif
}
static ssize_t _modbus_rtu_send(modbus_t *ctx, const uint8_t *req, int req_length)
{
#if defined(_WIN32)
modbus_rtu_t *ctx_rtu = ctx->backend_data;
DWORD n_bytes = 0;
return (WriteFile(ctx_rtu->w_ser.fd, req, req_length, &n_bytes, NULL)) ? n_bytes : -1;
#else
#if HAVE_DECL_TIOCM_RTS
modbus_rtu_t *ctx_rtu = ctx->backend_data;
if (ctx_rtu->rts != MODBUS_RTU_RTS_NONE) {
ssize_t size;
if (ctx->debug) {
fprintf(stderr, "Sending request using RTS signal\n");
}
_modbus_rtu_ioctl_rts(ctx->s, ctx_rtu->rts == MODBUS_RTU_RTS_UP);
usleep(_MODBUS_RTU_TIME_BETWEEN_RTS_SWITCH);
size = write(ctx->s, req, req_length);
usleep(ctx_rtu->onebyte_time * req_length + _MODBUS_RTU_TIME_BETWEEN_RTS_SWITCH);
_modbus_rtu_ioctl_rts(ctx->s, ctx_rtu->rts != MODBUS_RTU_RTS_UP);
return size;
} else {
#endif
return write(ctx->s, req, req_length);
#if HAVE_DECL_TIOCM_RTS
}
#endif
#endif
}
static int _modbus_rtu_receive(modbus_t *ctx, uint8_t *req)
{
int rc;
modbus_rtu_t *ctx_rtu = ctx->backend_data;
if (ctx_rtu->confirmation_to_ignore) {
_modbus_receive_msg(ctx, req, MSG_CONFIRMATION);
/* Ignore errors and reset the flag */
ctx_rtu->confirmation_to_ignore = FALSE;
rc = 0;
if (ctx->debug) {
printf("Confirmation to ignore\n");
}
} else {
rc = _modbus_receive_msg(ctx, req, MSG_INDICATION);
if (rc == 0) {
/* The next expected message is a confirmation to ignore */
ctx_rtu->confirmation_to_ignore = TRUE;
}
}
return rc;
}
static ssize_t _modbus_rtu_recv(modbus_t *ctx, uint8_t *rsp, int rsp_length)
{
#if defined(_WIN32)
return win32_ser_read(&((modbus_rtu_t *)ctx->backend_data)->w_ser, rsp, rsp_length);
#else
return read(ctx->s, rsp, rsp_length);
#endif
}
static int _modbus_rtu_flush(modbus_t *);
static int _modbus_rtu_pre_check_confirmation(modbus_t *ctx, const uint8_t *req,
const uint8_t *rsp, int rsp_length)
{
/* Check responding slave is the slave we requested (except for broacast
* request) */
if (req[0] != 0 && req[0] != rsp[0]) {
if (ctx->debug) {
fprintf(stderr,
"The responding slave %d isn't the requested slave %d",
rsp[0], req[0]);
}
errno = EMBBADSLAVE;
return -1;
} else {
return 0;
}
}
/* The check_crc16 function shall return 0 is the message is ignored and the
message length if the CRC is valid. Otherwise it shall return -1 and set
errno to EMBADCRC. */
static int _modbus_rtu_check_integrity(modbus_t *ctx, uint8_t *msg,
const int msg_length)
{
uint16_t crc_calculated;
uint16_t crc_received;
int slave = msg[0];
/* Filter on the Modbus unit identifier (slave) in RTU mode */
if (slave != ctx->slave && slave != MODBUS_BROADCAST_ADDRESS) {
/* Ignores the request (not for me) */
if (ctx->debug) {
printf("Request for slave %d ignored (not %d)\n", slave, ctx->slave);
}
return 0;
}
crc_calculated = crc16(msg, msg_length - 2);
crc_received = (msg[msg_length - 2] << 8) | msg[msg_length - 1];
/* Check CRC of msg */
if (crc_calculated == crc_received) {
return msg_length;
} else {
if (ctx->debug) {
fprintf(stderr, "ERROR CRC received %0X != CRC calculated %0X\n",
crc_received, crc_calculated);
}
if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) {
_modbus_rtu_flush(ctx);
}
errno = EMBBADCRC;
return -1;
}
}
/* Sets up a serial port for RTU communications */
static int _modbus_rtu_connect(modbus_t *ctx)
{
#if defined(_WIN32)
DCB dcb;
#else
struct termios tios;
speed_t speed;
int flags;
#endif
modbus_rtu_t *ctx_rtu = ctx->backend_data;
if (ctx->debug) {
printf("Opening %s at %d bauds (%c, %d, %d)\n",
ctx_rtu->device, ctx_rtu->baud, ctx_rtu->parity,
ctx_rtu->data_bit, ctx_rtu->stop_bit);
}
#if defined(_WIN32)
/* Some references here:
* http://msdn.microsoft.com/en-us/library/aa450602.aspx
*/
win32_ser_init(&ctx_rtu->w_ser);
/* ctx_rtu->device should contain a string like "COMxx:" xx being a decimal
* number */
ctx_rtu->w_ser.fd = CreateFileA(ctx_rtu->device,
GENERIC_READ | GENERIC_WRITE,
0,
NULL,
OPEN_EXISTING,
0,
NULL);
/* Error checking */
if (ctx_rtu->w_ser.fd == INVALID_HANDLE_VALUE) {
fprintf(stderr, "ERROR Can't open the device %s (LastError %d)\n",
ctx_rtu->device, (int)GetLastError());
return -1;
}
/* Save params */
ctx_rtu->old_dcb.DCBlength = sizeof(DCB);
if (!GetCommState(ctx_rtu->w_ser.fd, &ctx_rtu->old_dcb)) {
fprintf(stderr, "ERROR Error getting configuration (LastError %d)\n",
(int)GetLastError());
CloseHandle(ctx_rtu->w_ser.fd);
ctx_rtu->w_ser.fd = INVALID_HANDLE_VALUE;
return -1;
}
/* Build new configuration (starting from current settings) */
dcb = ctx_rtu->old_dcb;
/* Speed setting */
switch (ctx_rtu->baud) {
case 110:
dcb.BaudRate = CBR_110;
break;
case 300:
dcb.BaudRate = CBR_300;
break;
case 600:
dcb.BaudRate = CBR_600;
break;
case 1200:
dcb.BaudRate = CBR_1200;
break;
case 2400:
dcb.BaudRate = CBR_2400;
break;
case 4800:
dcb.BaudRate = CBR_4800;
break;
case 9600:
dcb.BaudRate = CBR_9600;
break;
case 19200:
dcb.BaudRate = CBR_19200;
break;
case 38400:
dcb.BaudRate = CBR_38400;
break;
case 57600:
dcb.BaudRate = CBR_57600;
break;
case 115200:
dcb.BaudRate = CBR_115200;
break;
default:
dcb.BaudRate = CBR_9600;
printf("WARNING Unknown baud rate %d for %s (B9600 used)\n",
ctx_rtu->baud, ctx_rtu->device);
}
/* Data bits */
switch (ctx_rtu->data_bit) {
case 5:
dcb.ByteSize = 5;
break;
case 6:
dcb.ByteSize = 6;
break;
case 7:
dcb.ByteSize = 7;
break;
case 8:
default:
dcb.ByteSize = 8;
break;
}
/* Stop bits */
if (ctx_rtu->stop_bit == 1)
dcb.StopBits = ONESTOPBIT;
else /* 2 */
dcb.StopBits = TWOSTOPBITS;
/* Parity */
if (ctx_rtu->parity == 'N') {
dcb.Parity = NOPARITY;
dcb.fParity = FALSE;
} else if (ctx_rtu->parity == 'E') {
dcb.Parity = EVENPARITY;
dcb.fParity = TRUE;
} else {
/* odd */
dcb.Parity = ODDPARITY;
dcb.fParity = TRUE;
}
/* Hardware handshaking left as default settings retrieved */
/* No software handshaking */
dcb.fTXContinueOnXoff = TRUE;
dcb.fOutX = FALSE;
dcb.fInX = FALSE;
/* Binary mode (it's the only supported on Windows anyway) */
dcb.fBinary = TRUE;
/* Don't want errors to be blocking */
dcb.fAbortOnError = FALSE;
/* TODO: any other flags!? */
/* Setup port */
if (!SetCommState(ctx_rtu->w_ser.fd, &dcb)) {
fprintf(stderr, "ERROR Error setting new configuration (LastError %d)\n",
(int)GetLastError());
CloseHandle(ctx_rtu->w_ser.fd);
ctx_rtu->w_ser.fd = INVALID_HANDLE_VALUE;
return -1;
}
#else
/* The O_NOCTTY flag tells UNIX that this program doesn't want
to be the "controlling terminal" for that port. If you
don't specify this then any input (such as keyboard abort
signals and so forth) will affect your process
Timeouts are ignored in canonical input mode or when the
NDELAY option is set on the file via open or fcntl */
flags = O_RDWR | O_NOCTTY | O_NDELAY | O_EXCL;
#ifdef O_CLOEXEC
flags |= O_CLOEXEC;
#endif
ctx->s = open(ctx_rtu->device, flags);
if (ctx->s == -1) {
fprintf(stderr, "ERROR Can't open the device %s (%s)\n",
ctx_rtu->device, strerror(errno));
return -1;
}
/* Save */
tcgetattr(ctx->s, &(ctx_rtu->old_tios));
memset(&tios, 0, sizeof(struct termios));
/* C_ISPEED Input baud (new interface)
C_OSPEED Output baud (new interface)
*/
switch (ctx_rtu->baud) {
case 110:
speed = B110;
break;
case 300:
speed = B300;
break;
case 600:
speed = B600;
break;
case 1200:
speed = B1200;
break;
case 2400:
speed = B2400;
break;
case 4800:
speed = B4800;
break;
case 9600:
speed = B9600;
break;
case 19200:
speed = B19200;
break;
case 38400:
speed = B38400;
break;
case 57600:
speed = B57600;
break;
case 115200:
speed = B115200;
break;
default:
speed = B9600;
if (ctx->debug) {
fprintf(stderr,
"WARNING Unknown baud rate %d for %s (B9600 used)\n",
ctx_rtu->baud, ctx_rtu->device);
}
}
/* Set the baud rate */
if ((cfsetispeed(&tios, speed) < 0) ||
(cfsetospeed(&tios, speed) < 0)) {
close(ctx->s);
ctx->s = -1;
return -1;
}
/* C_CFLAG Control options
CLOCAL Local line - do not change "owner" of port
CREAD Enable receiver
*/
tios.c_cflag |= (CREAD | CLOCAL);
/* CSIZE, HUPCL, CRTSCTS (hardware flow control) */
/* Set data bits (5, 6, 7, 8 bits)
CSIZE Bit mask for data bits
*/
tios.c_cflag &= ~CSIZE;
switch (ctx_rtu->data_bit) {
case 5:
tios.c_cflag |= CS5;
break;
case 6:
tios.c_cflag |= CS6;
break;
case 7:
tios.c_cflag |= CS7;
break;
case 8:
default:
tios.c_cflag |= CS8;
break;
}
/* Stop bit (1 or 2) */
if (ctx_rtu->stop_bit == 1)
tios.c_cflag &=~ CSTOPB;
else /* 2 */
tios.c_cflag |= CSTOPB;
/* PARENB Enable parity bit
PARODD Use odd parity instead of even */
if (ctx_rtu->parity == 'N') {
/* None */
tios.c_cflag &=~ PARENB;
} else if (ctx_rtu->parity == 'E') {
/* Even */
tios.c_cflag |= PARENB;
tios.c_cflag &=~ PARODD;
} else {
/* Odd */
tios.c_cflag |= PARENB;
tios.c_cflag |= PARODD;
}
/* Read the man page of termios if you need more information. */
/* This field isn't used on POSIX systems
tios.c_line = 0;
*/
/* C_LFLAG Line options
ISIG Enable SIGINTR, SIGSUSP, SIGDSUSP, and SIGQUIT signals
ICANON Enable canonical input (else raw)
XCASE Map uppercase \lowercase (obsolete)
ECHO Enable echoing of input characters
ECHOE Echo erase character as BS-SP-BS
ECHOK Echo NL after kill character
ECHONL Echo NL
NOFLSH Disable flushing of input buffers after
interrupt or quit characters
IEXTEN Enable extended functions
ECHOCTL Echo control characters as ^char and delete as ~?
ECHOPRT Echo erased character as character erased
ECHOKE BS-SP-BS entire line on line kill
FLUSHO Output being flushed
PENDIN Retype pending input at next read or input char
TOSTOP Send SIGTTOU for background output
Canonical input is line-oriented. Input characters are put
into a buffer which can be edited interactively by the user
until a CR (carriage return) or LF (line feed) character is
received.
Raw input is unprocessed. Input characters are passed
through exactly as they are received, when they are
received. Generally you'll deselect the ICANON, ECHO,
ECHOE, and ISIG options when using raw input
*/
/* Raw input */
tios.c_lflag &= ~(ICANON | ECHO | ECHOE | ISIG);
/* C_IFLAG Input options
Constant Description
INPCK Enable parity check
IGNPAR Ignore parity errors
PARMRK Mark parity errors
ISTRIP Strip parity bits
IXON Enable software flow control (outgoing)
IXOFF Enable software flow control (incoming)
IXANY Allow any character to start flow again
IGNBRK Ignore break condition
BRKINT Send a SIGINT when a break condition is detected
INLCR Map NL to CR
IGNCR Ignore CR
ICRNL Map CR to NL
IUCLC Map uppercase to lowercase
IMAXBEL Echo BEL on input line too long
*/
if (ctx_rtu->parity == 'N') {
/* None */
tios.c_iflag &= ~INPCK;
} else {
tios.c_iflag |= INPCK;
}
/* Software flow control is disabled */
tios.c_iflag &= ~(IXON | IXOFF | IXANY);
/* C_OFLAG Output options
OPOST Postprocess output (not set = raw output)
ONLCR Map NL to CR-NL
ONCLR ant others needs OPOST to be enabled
*/
/* Raw ouput */
tios.c_oflag &=~ OPOST;
/* C_CC Control characters
VMIN Minimum number of characters to read
VTIME Time to wait for data (tenths of seconds)
UNIX serial interface drivers provide the ability to
specify character and packet timeouts. Two elements of the
c_cc array are used for timeouts: VMIN and VTIME. Timeouts
are ignored in canonical input mode or when the NDELAY
option is set on the file via open or fcntl.
VMIN specifies the minimum number of characters to read. If
it is set to 0, then the VTIME value specifies the time to
wait for every character read. Note that this does not mean
that a read call for N bytes will wait for N characters to
come in. Rather, the timeout will apply to the first
character and the read call will return the number of
characters immediately available (up to the number you
request).
If VMIN is non-zero, VTIME specifies the time to wait for
the first character read. If a character is read within the
time given, any read will block (wait) until all VMIN
characters are read. That is, once the first character is
read, the serial interface driver expects to receive an
entire packet of characters (VMIN bytes total). If no
character is read within the time allowed, then the call to
read returns 0. This method allows you to tell the serial
driver you need exactly N bytes and any read call will
return 0 or N bytes. However, the timeout only applies to
the first character read, so if for some reason the driver
misses one character inside the N byte packet then the read
call could block forever waiting for additional input
characters.
VTIME specifies the amount of time to wait for incoming
characters in tenths of seconds. If VTIME is set to 0 (the
default), reads will block (wait) indefinitely unless the
NDELAY option is set on the port with open or fcntl.
*/
/* Unused because we use open with the NDELAY option */
tios.c_cc[VMIN] = 0;
tios.c_cc[VTIME] = 0;
if (tcsetattr(ctx->s, TCSANOW, &tios) < 0) {
close(ctx->s);
ctx->s = -1;
return -1;
}
#endif
return 0;
}
int modbus_rtu_set_serial_mode(modbus_t *ctx, int mode)
{
if (ctx->backend->backend_type == _MODBUS_BACKEND_TYPE_RTU) {
#if HAVE_DECL_TIOCSRS485
modbus_rtu_t *ctx_rtu = ctx->backend_data;
struct serial_rs485 rs485conf;
memset(&rs485conf, 0x0, sizeof(struct serial_rs485));
if (mode == MODBUS_RTU_RS485) {
rs485conf.flags = SER_RS485_ENABLED;
if (ioctl(ctx->s, TIOCSRS485, &rs485conf) < 0) {
return -1;
}
ctx_rtu->serial_mode = MODBUS_RTU_RS485;
return 0;
} else if (mode == MODBUS_RTU_RS232) {
/* Turn off RS485 mode only if required */
if (ctx_rtu->serial_mode == MODBUS_RTU_RS485) {
/* The ioctl call is avoided because it can fail on some RS232 ports */
if (ioctl(ctx->s, TIOCSRS485, &rs485conf) < 0) {
return -1;
}
}
ctx_rtu->serial_mode = MODBUS_RTU_RS232;
return 0;
}
#else
if (ctx->debug) {
fprintf(stderr, "This function isn't supported on your platform\n");
}
errno = ENOTSUP;
return -1;
#endif
}
/* Wrong backend and invalid mode specified */
errno = EINVAL;
return -1;
}
int modbus_rtu_get_serial_mode(modbus_t *ctx) {
if (ctx->backend->backend_type == _MODBUS_BACKEND_TYPE_RTU) {
#if HAVE_DECL_TIOCSRS485
modbus_rtu_t *ctx_rtu = ctx->backend_data;
return ctx_rtu->serial_mode;
#else
if (ctx->debug) {
fprintf(stderr, "This function isn't supported on your platform\n");
}
errno = ENOTSUP;
return -1;
#endif
} else {
errno = EINVAL;
return -1;
}
}
int modbus_rtu_set_rts(modbus_t *ctx, int mode)
{
if (ctx->backend->backend_type == _MODBUS_BACKEND_TYPE_RTU) {
#if HAVE_DECL_TIOCM_RTS
modbus_rtu_t *ctx_rtu = ctx->backend_data;
if (mode == MODBUS_RTU_RTS_NONE || mode == MODBUS_RTU_RTS_UP ||
mode == MODBUS_RTU_RTS_DOWN) {
ctx_rtu->rts = mode;
/* Set the RTS bit in order to not reserve the RS485 bus */
_modbus_rtu_ioctl_rts(ctx->s, ctx_rtu->rts != MODBUS_RTU_RTS_UP);
return 0;
}
#else
if (ctx->debug) {
fprintf(stderr, "This function isn't supported on your platform\n");
}
errno = ENOTSUP;
return -1;
#endif
}
/* Wrong backend or invalid mode specified */
errno = EINVAL;
return -1;
}
int modbus_rtu_get_rts(modbus_t *ctx) {
if (ctx->backend->backend_type == _MODBUS_BACKEND_TYPE_RTU) {
#if HAVE_DECL_TIOCM_RTS
modbus_rtu_t *ctx_rtu = ctx->backend_data;
return ctx_rtu->rts;
#else
if (ctx->debug) {
fprintf(stderr, "This function isn't supported on your platform\n");
}
errno = ENOTSUP;
return -1;
#endif
} else {
errno = EINVAL;
return -1;
}
}
static void _modbus_rtu_close(modbus_t *ctx)
{
/* Closes the file descriptor in RTU mode */
modbus_rtu_t *ctx_rtu = ctx->backend_data;
#if defined(_WIN32)
/* Revert settings */
if (!SetCommState(ctx_rtu->w_ser.fd, &ctx_rtu->old_dcb))
fprintf(stderr, "ERROR Couldn't revert to configuration (LastError %d)\n",
(int)GetLastError());
if (!CloseHandle(ctx_rtu->w_ser.fd))
fprintf(stderr, "ERROR Error while closing handle (LastError %d)\n",
(int)GetLastError());
#else
tcsetattr(ctx->s, TCSANOW, &(ctx_rtu->old_tios));
close(ctx->s);
#endif
}
static int _modbus_rtu_flush(modbus_t *ctx)
{
#if defined(_WIN32)
modbus_rtu_t *ctx_rtu = ctx->backend_data;
ctx_rtu->w_ser.n_bytes = 0;
return (FlushFileBuffers(ctx_rtu->w_ser.fd) == FALSE);
#else
return tcflush(ctx->s, TCIOFLUSH);
#endif
}
static int _modbus_rtu_select(modbus_t *ctx, fd_set *rset,
struct timeval *tv, int length_to_read)
{
int s_rc;
#if defined(_WIN32)
s_rc = win32_ser_select(&(((modbus_rtu_t*)ctx->backend_data)->w_ser),
length_to_read, tv);
if (s_rc == 0) {
errno = ETIMEDOUT;
return -1;
}
if (s_rc < 0) {
return -1;
}
#else
while ((s_rc = select(ctx->s+1, rset, NULL, NULL, tv)) == -1) {
if (errno == EINTR) {
if (ctx->debug) {
fprintf(stderr, "A non blocked signal was caught\n");
}
/* Necessary after an error */
FD_ZERO(rset);
FD_SET(ctx->s, rset);
} else {
return -1;
}
}
if (s_rc == 0) {
/* Timeout */
errno = ETIMEDOUT;
return -1;
}
#endif
return s_rc;
}
static void _modbus_rtu_free(modbus_t *ctx) {
free(((modbus_rtu_t*)ctx->backend_data)->device);
free(ctx->backend_data);
free(ctx);
}
const modbus_backend_t _modbus_rtu_backend = {
_MODBUS_BACKEND_TYPE_RTU,
_MODBUS_RTU_HEADER_LENGTH,
_MODBUS_RTU_CHECKSUM_LENGTH,
MODBUS_RTU_MAX_ADU_LENGTH,