modbus.c
56.9 KB
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
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
/*
Copyright (C) 2001-2007 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 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
The functions included here have been derived from the Modicon
Modbus Protocol Reference Guide which can be obtained from
Schneider at www.schneiderautomation.com.
Documentation:
http://www.easysw.com/~mike/serial/serial.html
*/
#include <fcntl.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <termio.h>
#include <sys/time.h>
#include <unistd.h>
#include <errno.h>
#include <glib.h>
/* TCP */
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <netinet/in.h>
#include <netinet/ip.h>
#include <netinet/tcp.h>
#include <modbus/modbus.h>
#define UNKNOWN_ERROR_MSG "Not defined in modbus specification"
static const int SIZE_TAB_ERROR_MSG = 12;
static const char *TAB_ERROR_MSG[] = {
/* 0x00 */ UNKNOWN_ERROR_MSG,
/* 0x01 */ "Illegal function code",
/* 0x02 */ "Illegal data address",
/* 0x03 */ "Illegal data value",
/* 0x04 */ "Slave device or server failure",
/* 0x05 */ "Acknowledge",
/* 0x06 */ "Slave device or server busy",
/* 0x07 */ "Negative acknowledge",
/* 0x08 */ "Memory parity error",
/* 0x09 */ UNKNOWN_ERROR_MSG,
/* 0x0A */ "Gateway path unavailable",
/* 0x0B */ "Target device failed to respond"
};
/* Table of CRC values for high-order byte */
static unsigned char 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 unsigned char 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
};
/* Local declaration */
static int read_reg_response(modbus_param_t *mb_param,
int *data_dest,
unsigned char *query);
/* Treats errors and flush or close connection if necessary */
static void error_treat(int ret, const char *string, modbus_param_t *mb_param)
{
if (ret == -1)
perror(string);
g_print("\n\nERROR %s\n\n", string);
if (mb_param->type_com == RTU) {
tcflush(mb_param->fd, TCIOFLUSH);
} else {
modbus_close(mb_param);
modbus_connect(mb_param);
}
}
/* Computes the size of the expected response */
static unsigned int compute_response_size(modbus_param_t *mb_param,
unsigned char *query)
{
int response_size_computed;
int offset;
offset = mb_param->header_length;
switch (query[offset + 1]) {
case FC_READ_COIL_STATUS:
case FC_READ_INPUT_STATUS: {
/* Header + nb values (code from force_multiple_coils) */
int coil_count = (query[offset + 4] << 8) | query[offset + 5];
response_size_computed = 3 +
(coil_count / 8) + ((coil_count % 8) ? 1 : 0);
}
break;
case FC_READ_HOLDING_REGISTERS:
case FC_READ_INPUT_REGISTERS:
/* Header + 2 * nb values */
response_size_computed = 3 +
2 * (query[offset + 4] << 8 | query[offset + 5]);
break;
case FC_READ_EXCEPTION_STATUS:
response_size_computed = 4;
break;
default:
response_size_computed = 6;
}
response_size_computed += offset + mb_param->checksum_size;
return response_size_computed;
}
/* Buils a RTU header */
int build_query_packet_rtu(int slave, int function, int start_addr,
int count, unsigned char *packet)
{
packet[0] = slave;
packet[1] = function;
packet[2] = start_addr >> 8;
packet[3] = start_addr & 0x00ff;
packet[4] = count >> 8;
packet[5] = count & 0x00ff;
return PRESET_QUERY_SIZE_RTU;
}
/* Builds a TCP header */
int build_query_packet_tcp(int slave, int function, int start_addr,
int count, unsigned char *packet)
{
static unsigned short t_id = 0;
/* Transaction ID */
if (t_id < USHRT_MAX)
t_id++;
else
t_id = 0;
packet[0] = t_id >> 8;
packet[1] = t_id & 0x00ff;
/* Protocol Modbus */
packet[2] = 0;
packet[3] = 0;
/* Length to fix later with set_packet_length_tcp (4 and 5) */
packet[6] = slave;
packet[7] = function;
packet[8] = start_addr >> 8;
packet[9] = start_addr & 0x00ff;
packet[10] = count >> 8;
packet[11] = count & 0x00ff;
return PRESET_QUERY_SIZE_TCP;
}
int build_query_packet(modbus_param_t *mb_param, int slave,
int function, int start_addr,
int count, unsigned char *packet)
{
if (mb_param->type_com == RTU)
return build_query_packet_rtu(slave, function, start_addr,
count, packet);
else
return build_query_packet_tcp(slave, function, start_addr,
count, packet);
}
int build_response_packet_rtu(int slave, int function, int byte_count, unsigned char *packet)
{
packet[0] = slave;
packet[1] = function;
packet[2] = byte_count;
/* FIXME +1 */
return PRESET_RESPONSE_SIZE_RTU+1;
}
int build_response_packet_tcp(int slave, int function, int byte_count, unsigned char *packet)
{
static unsigned short t_id = 0;
/* Transaction ID */
if (t_id < USHRT_MAX)
t_id++;
else
t_id = 0;
packet[0] = t_id >> 8;
packet[1] = t_id & 0x00ff;
/* Protocol Modbus */
packet[2] = 0;
packet[3] = 0;
/* Length to fix later with set_packet_length_tcp (4 and 5) */
packet[6] = slave;
packet[7] = function;
packet[8] = byte_count;
/* FIXME +1 */
return PRESET_RESPONSE_SIZE_TCP+1;
}
int build_response_packet(modbus_param_t *mb_param, int slave,
int function, int byte_count, unsigned char *packet)
{
if (mb_param->type_com == RTU)
return build_response_packet_rtu(slave, function, byte_count, packet);
else
return build_response_packet_tcp(slave, function, byte_count, packet);
}
/* Sets the length of TCP message in the message */
void set_packet_length_tcp(unsigned char *packet, size_t packet_size)
{
unsigned short mbap_length;
/* Substract MBAP header length */
mbap_length = packet_size - 6;
packet[4] = mbap_length >> 8;
packet[5] = mbap_length & 0x00FF;
}
/* Fast CRC */
static unsigned short crc16(unsigned char *buffer,
unsigned short buffer_length)
{
unsigned char crc_hi = 0xFF; /* high CRC byte initialized */
unsigned char 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);
}
/* If CRC is correct returns 0 else returns INVALID_CRC */
int check_crc16(modbus_param_t *mb_param,
unsigned char *msg,
int msg_size)
{
int ret;
if (mb_param->type_com == RTU) {
unsigned short crc_calc;
unsigned short crc_received;
crc_calc = crc16(msg, msg_size - 2);
crc_received = (msg[msg_size - 2] << 8) | msg[msg_size - 1];
/* Check CRC of msg */
if (crc_calc == crc_received) {
ret = 0;
} else {
char *s_error;
s_error = g_strdup_printf(
"invalid crc received %0X - crc_calc %0X",
crc_received, crc_calc);
error_treat(0, s_error, mb_param);
g_free(s_error);
ret = INVALID_CRC;
}
} else {
/* In TCP, the modbus CRC is not present (see HDLC level) */
ret = 0;
}
return ret;
}
/* Sends a query/response over a serial or a TCP communication */
static int modbus_send(modbus_param_t *mb_param, unsigned char *query,
size_t query_size)
{
int write_ret;
unsigned short s_crc;
int i;
if (mb_param->type_com == RTU) {
s_crc = crc16(query, query_size);
query[query_size++] = s_crc >> 8;
query[query_size++] = s_crc & 0x00FF;
} else {
set_packet_length_tcp(query, query_size);
}
if (mb_param->debug) {
g_print("\n");
for (i = 0; i < query_size; i++)
g_print("[%.2X]", query[i]);
g_print("\n");
}
if (mb_param->type_com == RTU)
write_ret = write(mb_param->fd, query, query_size);
else
write_ret = send(mb_param->fd, query, query_size, 0);
/* Return the number of bytes written (0 to n)
or PORT_SOCKET_FAILURE on error */
if ((write_ret == -1) || (write_ret != query_size)) {
error_treat(write_ret, "Write port/socket failure", mb_param);
write_ret = PORT_SOCKET_FAILURE;
}
return write_ret;
}
/* Computes the size of the header following the function code */
int compute_query_size_header(int function)
{
int byte;
if (function <= FC_FORCE_SINGLE_COIL)
/* Read and single write */
byte = 4;
else if (function == FC_FORCE_MULTIPLE_COILS ||
function == FC_PRESET_MULTIPLE_REGISTERS)
/* Multiple write */
byte = 5;
else
byte = 0;
g_print("compute_query_size_header FC %d, B%d\n", function, byte);
return byte;
}
/* Computes the size of the data to write in the query */
int compute_query_size_data(modbus_param_t *mb_param, unsigned char *msg)
{
int function = msg[mb_param->header_length + 1];
int byte;
if (function == FC_FORCE_MULTIPLE_COILS ||
function == FC_PRESET_MULTIPLE_REGISTERS)
byte = msg[mb_param->header_length + 6];
else
byte = 0;
byte += mb_param->checksum_size;
g_print("compute_query_size_data FC %d, B %d\n", function, byte);
return byte;
}
#define WAIT_DATA() \
{ \
while ((select_ret = select(mb_param->fd+1, &rfds, NULL, NULL, &tv)) == -1) { \
if (errno == EINTR) { \
g_print("A non blocked signal was caught\n"); \
/* Necessary after an error */ \
FD_ZERO(&rfds); \
FD_SET(mb_param->fd, &rfds); \
} else { \
error_treat(select_ret, "Select failure", mb_param); \
return SELECT_FAILURE; \
} \
} \
\
if (select_ret == 0) { \
/* Call to error_treat is done later to manage exceptions */ \
return COMM_TIME_OUT; \
} \
}
/* Monitors for the reply from the modbus slave or to receive query
from a modbus master.
This function blocks for timeout seconds if there is no reply.
msg_size_computed must be set to MSG_SIZE_COMPUTED if undefined
Returns:
- 0: OK, <0: error
- msg_size: number of characters received. */
int receive_msg(modbus_param_t *mb_param,
int msg_size_computed,
unsigned char *msg,
int *msg_size)
{
int select_ret;
int read_ret;
fd_set rfds;
struct timeval tv;
int size_to_read;
unsigned char *p_msg;
enum { FUNCTION, BYTE, COMPLETE };
int state;
if (mb_param->debug) {
if (msg_size_computed == MSG_SIZE_UNDEFINED)
g_print("Waiting for a message...\n");
else
g_print("Waiting for a message (%d bytes)...\n", msg_size_computed);
}
/* Add a file descriptor to the set */
FD_ZERO(&rfds);
FD_SET(mb_param->fd, &rfds);
if (msg_size_computed == MSG_SIZE_UNDEFINED) {
/* Wait for a message */
tv.tv_sec = 60;
tv.tv_usec = 0;
/* The message size is undefined (query receiving) so
* we need to analyse the message step by step.
* In the first step, we want to reach the function code */
msg_size_computed = mb_param->header_length + 2;
state = FUNCTION;
} else {
tv.tv_sec = 0;
tv.tv_usec = TIME_OUT_BEGIN_OF_TRAME;
state = COMPLETE;
}
size_to_read = msg_size_computed;
WAIT_DATA();
/* Read the msg */
(*msg_size) = 0;
p_msg = msg;
while (select_ret) {
if (mb_param->type_com == RTU)
read_ret = read(mb_param->fd, p_msg, size_to_read);
else
read_ret = recv(mb_param->fd, p_msg, size_to_read, 0);
if (read_ret == -1) {
error_treat(read_ret, "Read port/socket failure", mb_param);
return PORT_SOCKET_FAILURE;
}
/* Sums bytes received */
(*msg_size) += read_ret;
if ((*msg_size) > MAX_PACKET_SIZE) {
error_treat(0, "Too many datas", mb_param);
return TOO_MANY_DATAS;
}
/* Display the hex code of each character received */
if (mb_param->debug) {
int i;
for (i=0; i < read_ret; i++)
g_print("<%.2X>", p_msg[i]);
}
if ((*msg_size) < msg_size_computed) {
/* Message incomplete */
size_to_read = msg_size_computed - (*msg_size);
} else {
switch (state) {
case FUNCTION:
/* Function code position */
size_to_read = compute_query_size_header(msg[mb_param->header_length + 1]);
msg_size_computed += size_to_read;
state = BYTE;
g_print("\nBYTE:");
break;
case BYTE:
size_to_read = compute_query_size_data(mb_param, msg);
msg_size_computed += size_to_read;
state = COMPLETE;
g_print("\nCOMPLETE:");
break;
case COMPLETE:
size_to_read = 0;
break;
}
}
g_print(" size to read %d\n", size_to_read);
/* Moves the pointer to receive other datas */
p_msg = &(p_msg[read_ret]);
if (size_to_read > 0) {
/* If no character at the buffer wait
TIME_OUT_END_OF_TRAME before to generate an error. */
tv.tv_sec = 0;
tv.tv_usec = TIME_OUT_END_OF_TRAME;
WAIT_DATA();
} else {
/* All chars are received */
select_ret = FALSE;
}
}
if (mb_param->debug)
g_print("\n");
/* OK */
return 0;
}
/* Checks whether the right response is returned with good checksum.
Returns:
- the numbers of values (bits or word) if success
- less than 0 for exception errors
Note: All functions used to send or receive data with modbus return
these values. */
static int modbus_check_response(modbus_param_t *mb_param,
unsigned char *query,
unsigned char *response)
{
int response_size;
int response_size_computed; int offset = mb_param->header_length;
int ret;
response_size_computed = compute_response_size(mb_param, query);
ret = receive_msg(mb_param, response_size_computed, response, &response_size);
if (ret == 0) {
/* Check message */
ret = check_crc16(mb_param, response, response_size);
if (ret != 0)
return ret;
/* Good response */
switch (response[offset + 1]) {
case FC_READ_COIL_STATUS:
case FC_READ_INPUT_STATUS:
/* Read functions 1 value = 1 byte */
response_size = response[offset + 2];
break;
case FC_READ_HOLDING_REGISTERS:
case FC_READ_INPUT_REGISTERS:
/* Read functions 1 value = 2 bytes */
response_size = response[offset + 2] / 2;
break;
case FC_FORCE_MULTIPLE_COILS:
case FC_PRESET_MULTIPLE_REGISTERS:
/* N Write functions */
response_size = response[offset + 4] << 8 |
response[offset + 5];
break;
case FC_REPORT_SLAVE_ID:
/* Report slave ID (bytes received) */
break;
default:
/* 1 Write functions & others */
response_size = 1;
}
} else if (ret == COMM_TIME_OUT &&
response_size == offset + 3 + mb_param->checksum_size) {
/* Optimisation allowed because exception response is
the smallest trame in modbus protocol (3) so always
raise an timeout error */
/* CRC */
ret = check_crc16(mb_param, response, response_size);
if (ret != 0)
return ret;
/* Check for exception response
0x80 + function */
if (0x80 + query[offset + 1] == response[offset + 1]) {
if (response[offset + 2] < SIZE_TAB_ERROR_MSG) {
error_treat(0,
TAB_ERROR_MSG[response[offset + 2]],
mb_param);
/* Modbus error code (negative) */
return -response[offset + 2];
} else {
/* The chances are low to hit this
case but can avoid a vicious
segfault */
char *s_error;
s_error = g_strdup_printf(
"Invalid exception code %d",
response[offset + 2]);
error_treat(0, s_error, mb_param);
g_free(s_error);
return INVALID_EXCEPTION_CODE;
}
}
} else if (ret == COMM_TIME_OUT) {
error_treat(0, "Communication time out", mb_param);
return COMM_TIME_OUT;
} else {
return ret;
}
return response_size;
}
int response_io_status(int address, int count,
int nb_io_status, unsigned char *tab_io_status,
unsigned char *response, int offset)
{
unsigned char shift = 0;
unsigned char byte = 0;
int i;
for (i = address; i < address+count; i++) {
byte |= tab_io_status[i] << shift;
if (shift == 7) {
/* Byte is full */
response[offset++] = byte;
byte = shift = 0;
} else {
shift++;
}
}
if (shift != 0)
response[offset++] = byte;
return offset;
}
/* Manages the received query.
Analyses the query and constructs a response */
void manage_query(modbus_param_t *mb_param, unsigned char *query,
int query_size, modbus_mapping_t *mb_mapping)
{
int offset = mb_param->header_length;
int slave = query[offset];
int function = query[offset+1];
int address = (query[offset+2] << 8) + query[offset+3];
/* FIXME count/data */
int count;
int data;
unsigned char response[MAX_PACKET_SIZE];
int byte_count;
int i;
/* FIXME address illegal used in mb_mapping->tab_X */
switch (function) {
case FC_READ_COIL_STATUS:
count = (query[offset+4] << 8) + query[offset+5];
byte_count = (count / 8.0) + ((count % 8) ? 1 : 0);
offset = build_response_packet(mb_param, slave, function, byte_count, response);
offset = response_io_status(address, count,
mb_mapping->nb_coil_status, mb_mapping->tab_coil_status,
response, offset);
break;
case FC_READ_INPUT_STATUS:
count = (query[offset+4] << 8) + query[offset+5];
byte_count = (count / 8.0) + ((count % 8) ? 1 : 0);
offset = build_response_packet(mb_param, slave, function, byte_count, response);
offset = response_io_status(address, count,
mb_mapping->nb_input_status, mb_mapping->tab_input_status,
response, offset);
break;
case FC_READ_HOLDING_REGISTERS:
count = (query[offset+4] << 8) + query[offset+5];
byte_count = 2 * count;
offset = build_response_packet(mb_param, slave, function, byte_count, response);
g_print("offset %d\n", offset);
for (i = address; i < address + count; i++) {
response[offset++] = mb_mapping->tab_holding_registers[i] >> 8;
response[offset++] = mb_mapping->tab_holding_registers[i] & 0xFF;
}
g_print("fin offset %d\n", offset);
break;
case FC_READ_INPUT_REGISTERS:
count = (query[offset+4] << 8) + query[offset+5];
byte_count = 2 * count;
offset = build_response_packet(mb_param, slave, function, byte_count, response);
for (i = address; i < address + count; i++) {
response[offset++] = mb_mapping->tab_input_registers[i] >> 8;
response[offset++] = mb_mapping->tab_input_registers[i] & 0xFF;
}
break;
case FC_FORCE_SINGLE_COIL:
data = (query[offset+4] << 8) + query[offset+5];
if (data == 0xFF00)
mb_mapping->tab_coil_status[address] = ON;
else if (data == 0x0)
mb_mapping->tab_coil_status[address] = OFF;
else
g_print("FIXME Error %d\n", data);
g_print("FIXME works only in TCP mode (CRC)");
memcpy(response, query, query_size);
offset = query_size;
break;
case FC_PRESET_SINGLE_REGISTER:
case FC_READ_EXCEPTION_STATUS:
case FC_FORCE_MULTIPLE_COILS:
case FC_PRESET_MULTIPLE_REGISTERS:
case FC_REPORT_SLAVE_ID:
g_print("Not implemented\n");
break;
}
modbus_send(mb_param, response, offset);
}
/* Listens any message on a socket or file descriptor.
Returns:
- 0 if OK, or a negative error number if the request fails
- query, message received
- query_size, size in bytes of the message */
int modbus_listen(modbus_param_t *mb_param, unsigned char *query, int *query_size)
{
int offset = mb_param->header_length;
int ret;
ret = receive_msg(mb_param, MSG_SIZE_UNDEFINED, query, query_size);
if (ret == 0) {
ret = check_crc16(mb_param, query, *query_size);
}
return ret;
}
/* Reads IO status */
static int read_io_status(modbus_param_t *mb_param, int slave, int function,
int start_addr, int count, int *data_dest)
{
int query_size;
int query_ret;
int response_ret;
unsigned char query[MIN_QUERY_SIZE];
unsigned char response[MAX_PACKET_SIZE];
query_size = build_query_packet(mb_param, slave, function,
start_addr, count, query);
query_ret = modbus_send(mb_param, query, query_size);
if (query_ret > 0) {
int i, temp, bit;
int pos = 0;
int processed = 0;
int offset;
int offset_length;
response_ret = modbus_check_response(mb_param, query, response);
offset = mb_param->header_length;
offset_length = offset + response_ret;
for (i = offset; i < offset_length; i++) {
/* Shift reg hi_byte to temp */
temp = response[3 + i];
for (bit = 0x01; (bit & 0xff) && (processed < count);) {
data_dest[pos++] = (temp & bit) ? TRUE : FALSE;
processed++;
bit = bit << 1;
}
}
} else {
response_ret = query_ret;
}
return response_ret;
}
/* Reads the boolean status of coils and sets the array elements
in the destination to TRUE or FALSE. */
int read_coil_status(modbus_param_t *mb_param, int slave, int start_addr,
int count, int *data_dest)
{
int status;
status = read_io_status(mb_param, slave, FC_READ_COIL_STATUS,
start_addr, count, data_dest);
if (status > 0)
status = count;
return status;
}
/* Same as read_coil_status but reads the slaves input table */
int read_input_status(modbus_param_t *mb_param, int slave, int start_addr,
int count, int *data_dest)
{
int status;
status = read_io_status(mb_param, slave, FC_READ_INPUT_STATUS,
start_addr, count, data_dest);
if (status > 0)
status = count;
return status;
}
/* Reads the data from a modbus slave and put that data into an array */
static int read_registers(modbus_param_t *mb_param, int slave, int function,
int start_addr, int count, int *data_dest)
{
int query_size;
int status;
int query_ret;
unsigned char query[MIN_QUERY_SIZE];
query_size = build_query_packet(mb_param, slave, function,
start_addr, count, query);
query_ret = modbus_send(mb_param, query, query_size);
if (query_ret > 0)
status = read_reg_response(mb_param, data_dest, query);
else
status = query_ret;
return status;
}
/* Reads the holding registers in a slave and put the data into an
array */
int read_holding_registers(modbus_param_t *mb_param, int slave,
int start_addr, int count, int *data_dest)
{
int status;
if (count > MAX_READ_HOLD_REGS) {
g_print("WARNING Too many holding registers requested\n");
count = MAX_READ_HOLD_REGS;
}
status = read_registers(mb_param, slave, FC_READ_HOLDING_REGISTERS,
start_addr, count, data_dest);
return status;
}
/* Reads the input registers in a slave and put the data into
an array */
int read_input_registers(modbus_param_t *mb_param, int slave,
int start_addr, int count, int *data_dest)
{
int status;
if (count > MAX_READ_INPUT_REGS) {
g_print("WARNING Too many input registers requested\n");
count = MAX_READ_INPUT_REGS;
}
status = read_registers(mb_param, slave, FC_READ_INPUT_REGISTERS,
start_addr, count, data_dest);
return status;
}
/* Reads the response data from a slave and puts the data into an
array */
static int read_reg_response(modbus_param_t *mb_param, int *data_dest,
unsigned char *query)
{
unsigned char response[MAX_PACKET_SIZE];
int response_ret;
int offset;
int i;
response_ret = modbus_check_response(mb_param, query, response);
offset = mb_param->header_length;
/* If response_ret is negative, the loop is jumped ! */
for (i = 0; i < response_ret; i++) {
/* shift reg hi_byte to temp OR with lo_byte */
data_dest[i] = response[offset + 3 + (i << 1)] << 8 |
response[offset + 4 + (i << 1)];
}
return response_ret;
}
/* Gets the raw data from the input stream */
static int preset_response(modbus_param_t *mb_param, unsigned char *query)
{
int ret;
unsigned char response[MAX_PACKET_SIZE];
ret = modbus_check_response(mb_param, query, response);
return ret;
}
/* Sends a value to a register in a slave */
static int set_single(modbus_param_t *mb_param, int slave, int function,
int addr, int value)
{
int status;
int query_size;
int query_ret;
unsigned char query[MAX_PACKET_SIZE];
query_size = build_query_packet(mb_param, slave, function,
addr, value, query);
query_ret = modbus_send(mb_param, query, query_size);
if (query_ret > 0)
status = preset_response(mb_param, query);
else
status = query_ret;
return status;
}
/* Turns on or off a single coil on the slave device */
int force_single_coil(modbus_param_t *mb_param, int slave,
int coil_addr, int state)
{
int status;
if (state)
state = 0xFF00;
status = set_single(mb_param, slave, FC_FORCE_SINGLE_COIL, coil_addr, state);
return status;
}
/* Sets a value in one holding register in the slave device */
int preset_single_register(modbus_param_t *mb_param, int slave,
int reg_addr, int value)
{
int status;
status = set_single(mb_param, slave, FC_PRESET_SINGLE_REGISTER, reg_addr, value);
return status;
}
/* Takes an array of ints and sets or resets the coils on a slave
appropriatly */
int force_multiple_coils(modbus_param_t *mb_param, int slave,
int start_addr, int coil_count,
int *data_src)
{
int i;
int byte_count;
int query_size;
int coil_check = 0;
int status;
int query_ret;
int pos = 0;
unsigned char query[MAX_PACKET_SIZE];
if (coil_count > MAX_WRITE_COILS) {
g_print("WARNING Writing to too many coils\n");
coil_count = MAX_WRITE_COILS;
}
query_size = build_query_packet(mb_param, slave, FC_FORCE_MULTIPLE_COILS,
start_addr, coil_count, query);
byte_count = (coil_count / 8) + ((coil_count % 8) ? 1 : 0);
query[query_size++] = byte_count;
for (i = 0; i < byte_count; i++) {
int bit;
bit = 0x01;
query[query_size] = 0;
while ((bit & 0xFF) && (coil_check++ < coil_count)) {
if (data_src[pos++])
query[query_size] |= bit;
else
query[query_size] &=~ bit;
bit = bit << 1;
}
query_size++;
}
query_ret = modbus_send(mb_param, query, query_size);
if (query_ret > 0)
status = preset_response(mb_param, query);
else
status = query_ret;
return status;
}
/* Copies the values in an array to an array on the slave */
int preset_multiple_registers(modbus_param_t *mb_param, int slave,
int start_addr, int reg_count, int *data_src)
{
int i;
int query_size;
int byte_count;
int status;
int query_ret;
unsigned char query[MAX_PACKET_SIZE];
if (reg_count > MAX_WRITE_REGS) {
g_print("WARNING Trying to write to too many registers\n");
reg_count = MAX_WRITE_REGS;
}
query_size = build_query_packet(mb_param, slave,
FC_PRESET_MULTIPLE_REGISTERS,
start_addr, reg_count, query);
byte_count = reg_count * 2;
query[query_size++] = byte_count;
for (i = 0; i < reg_count; i++) {
query[query_size++] = data_src[i] >> 8;
query[query_size++] = data_src[i] & 0x00FF;
}
query_ret = modbus_send(mb_param, query, query_size);
if (query_ret > 0)
status = preset_response(mb_param, query);
else
status = query_ret;
return status;
}
/* Returns the slave id ! */
int report_slave_id(modbus_param_t *mb_param, int slave,
unsigned char *data_dest)
{
int query_size;
int query_ret;
int response_ret;
unsigned char query[MIN_QUERY_SIZE];
unsigned char response[MAX_PACKET_SIZE];
query_size = build_query_packet(mb_param, slave, FC_REPORT_SLAVE_ID,
0, 0, query);
/* start_addr and count are not used */
query_size -= 4;
query_ret = modbus_send(mb_param, query, query_size);
if (query_ret > 0) {
int i;
int offset;
int offset_length;
/* Byte count, slave id, run indicator status,
additional data */
response_ret = modbus_check_response(mb_param, query, response);
offset = mb_param->header_length;
offset_length = offset + response_ret;
for (i = offset; i < offset_length; i++)
data_dest[i] = response[i];
} else {
response_ret = query_ret;
}
return response_ret;
}
/* Initialises the modbus_param_t structure for RTU */
void modbus_init_rtu(modbus_param_t *mb_param, char *device,
int baud_i, char *parity, int data_bit,
int stop_bit)
{
memset(mb_param, 0, sizeof(modbus_param_t));
strcpy(mb_param->device, device);
mb_param->baud_i = baud_i;
strcpy(mb_param->parity, parity);
mb_param->debug = FALSE;
mb_param->data_bit = data_bit;
mb_param->stop_bit = stop_bit;
mb_param->type_com = RTU;
mb_param->header_length = HEADER_LENGTH_RTU;
mb_param->checksum_size = CHECKSUM_SIZE_RTU;
}
/* Initialises the modbus_param_t structure for TCP */
void modbus_init_tcp(modbus_param_t *mb_param, char *ip)
{
memset(mb_param, 0, sizeof(modbus_param_t));
strncpy(mb_param->ip, ip, sizeof(char)*16);
mb_param->type_com = TCP;
mb_param->header_length = HEADER_LENGTH_TCP;
mb_param->checksum_size = CHECKSUM_SIZE_TCP;
}
/* This function sets up a serial port for RTU communications to
modbus */
static int modbus_connect_rtu(modbus_param_t *mb_param)
{
struct termios tios;
speed_t baud_rate;
if (mb_param->debug) {
g_print("Opening %s at %d bauds (%s)\n",
mb_param->device, mb_param->baud_i, mb_param->parity);
}
/* 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 */
mb_param->fd = open(mb_param->device, O_RDWR | O_NOCTTY | O_NDELAY);
if (mb_param->fd < 0) {
perror("open");
g_print("ERROR Opening device %s (no : %d)\n",
mb_param->device, errno);
return -1;
}
/* Save */
tcgetattr(mb_param->fd, &(mb_param->old_tios));
memset(&tios, 0, sizeof(struct termios));
/* C_ISPEED Input baud (new interface)
C_OSPEED Output baud (new interface)
*/
switch (mb_param->baud_i) {
case 110:
baud_rate = B110;
break;
case 300:
baud_rate = B300;
break;
case 600:
baud_rate = B600;
break;
case 1200:
baud_rate = B1200;
break;
case 2400:
baud_rate = B2400;
break;
case 4800:
baud_rate = B4800;
break;
case 9600:
baud_rate = B9600;
break;
case 19200:
baud_rate = B19200;
break;
case 38400:
baud_rate = B38400;
break;
case 57600:
baud_rate = B57600;
break;
case 115200:
baud_rate = B115200;
break;
default:
baud_rate = B9600;
g_print("WARNING Unknown baud rate %d for %s (B9600 used)\n",
mb_param->baud_i, mb_param->device);
}
/* Set the baud rate */
if ((cfsetispeed(&tios, baud_rate) < 0) ||
(cfsetospeed(&tios, baud_rate) < 0)) {
perror("cfsetispeed/cfsetospeed\n");
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 (mb_param->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 (mb_param->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 (strncmp(mb_param->parity, "none", 4) == 0) {
tios.c_cflag &=~ PARENB;
} else if (strncmp(mb_param->parity, "even", 4) == 0) {
tios.c_cflag |= PARENB;
tios.c_cflag &=~ PARODD;
} else {
/* odd */
tios.c_cflag |= PARENB;
tios.c_cflag |= PARODD;
}
/* Read your man page for the meaning of all this (man
termios). Its a bit to involved to comment here :) */
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 (strncmp(mb_param->parity, "none", 4) == 0) {
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(mb_param->fd, TCSANOW, &tios) < 0) {
perror("tcsetattr\n");
return -1;
}
return 0;
}
/* Establishes a modbus connection with a modbus slave */
static int modbus_connect_tcp(modbus_param_t *mb_param)
{
int ret;
int option;
struct sockaddr_in addr;
addr.sin_family = AF_INET;
addr.sin_port = htons(MODBUS_TCP_PORT);
addr.sin_addr.s_addr = inet_addr(mb_param->ip);
mb_param->fd = socket(AF_INET, SOCK_STREAM, 0);
if (mb_param->fd < 0) {
return mb_param->fd;
}
/* Set the TCP no delay flag */
/* SOL_TCP = IPPROTO_TCP */
option = 1;
ret = setsockopt(mb_param->fd, SOL_TCP, TCP_NODELAY,
(const void *)&option, sizeof(int));
if (ret < 0) {
perror("setsockopt");
close(mb_param->fd);
return ret;
}
/* Set the IP low delay option */
option = IPTOS_LOWDELAY;
ret = setsockopt(mb_param->fd, SOL_TCP, IP_TOS,
(const void *)&option, sizeof(int));
if (ret < 0) {
perror("setsockopt");
close(mb_param->fd);
return ret;
}
if (mb_param->debug) {
g_print("Connecting to %s\n", mb_param->ip);
}
ret = connect(mb_param->fd, (struct sockaddr *)&addr,
sizeof(struct sockaddr_in));
if (ret < 0) {
perror("connect");
close(mb_param->fd);
return ret;
}
return 0;
}
/* Establishes a modbus connexion */
int modbus_connect(modbus_param_t *mb_param)
{
int ret;
if (mb_param->type_com == RTU)
ret = modbus_connect_rtu(mb_param);
else
ret = modbus_connect_tcp(mb_param);
return ret;
}
/* Allocates 4 arrays to store coils, input status, input registers and
holding registers. The pointers are stored in modbus_mapping structure.
Returns: TRUE if ok, FALSE on failure
*/
int modbus_mapping_new(modbus_mapping_t *mb_mapping,
int nb_coil_status, int nb_input_status,
int nb_input_registers, int nb_holding_registers)
{
/* 0X */
mb_mapping->nb_coil_status = nb_coil_status;
mb_mapping->tab_coil_status = (unsigned char *) g_malloc0(nb_coil_status * sizeof(unsigned char));
if (mb_mapping->tab_coil_status == NULL)
return FALSE;
/* 1X */
mb_mapping->nb_input_status = nb_input_status;
mb_mapping->tab_input_status = (unsigned char *) g_malloc0(nb_input_status * sizeof(unsigned char));
if (mb_mapping->tab_input_status == NULL) {
g_free(mb_mapping->tab_coil_status);
return FALSE;
}
/* 3X */
mb_mapping->nb_input_registers = nb_input_registers;
mb_mapping->tab_input_registers = (unsigned short *) g_malloc0(nb_input_registers * sizeof(unsigned short));
if (mb_mapping->tab_input_registers == NULL) {
g_free(mb_mapping->tab_coil_status);
g_free(mb_mapping->tab_input_status);
return FALSE;
}
/* 4X */
mb_mapping->nb_holding_registers = nb_holding_registers;
mb_mapping->tab_holding_registers = (unsigned short *) g_malloc0(nb_holding_registers * sizeof(unsigned short));
if (mb_mapping->tab_holding_registers == NULL) {
g_free(mb_mapping->tab_coil_status);
g_free(mb_mapping->tab_input_status);
g_free(mb_mapping->tab_input_registers);
return FALSE;
}
return TRUE;
}
/* Frees the 4 arrays */
void modbus_mapping_free(modbus_mapping_t *mb_mapping)
{
g_free(mb_mapping->tab_coil_status);
g_free(mb_mapping->tab_input_status);
g_free(mb_mapping->tab_input_registers);
g_free(mb_mapping->tab_holding_registers);
}
/* Listens for any query from a modbus master */
int modbus_init_listen_tcp(modbus_param_t *mb_param)
{
int ret;
int new_socket;
struct sockaddr_in addr;
socklen_t addrlen;
addr.sin_family = AF_INET;
/* The modbus port is < 1024
This program must be made setuid root. */
addr.sin_port = htons(MODBUS_TCP_PORT);
addr.sin_addr.s_addr = INADDR_ANY;
memset(&(addr.sin_zero), '\0', 8);
new_socket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
if (new_socket < 0) {
perror("socket");
exit(1);
} else {
g_print("Socket OK\n");
}
ret = bind(new_socket, (struct sockaddr *)&addr,
sizeof(struct sockaddr_in));
if (ret < 0) {
perror("bind");
close(new_socket);
exit(1);
} else {
g_print("Bind OK\n");
}
ret = listen(new_socket, 1);
if (ret != 0) {
perror("listen");
close(new_socket);
exit(1);
} else {
g_print("Listen OK\n");
}
addrlen = sizeof(struct sockaddr_in);
mb_param->fd = accept(new_socket, (struct sockaddr *)&addr, &addrlen);
if (ret < 0) {
perror("accept");
close(new_socket);
new_socket = 0;
exit(1);
} else {
g_print("The client %s is connected\n",
inet_ntoa(addr.sin_addr));
}
return new_socket;
}
/* Closes the file descriptor in RTU mode */
static void modbus_close_rtu(modbus_param_t *mb_param)
{
if (tcsetattr(mb_param->fd, TCSANOW, &(mb_param->old_tios)) < 0)
perror("tcsetattr");
close(mb_param->fd);
}
/* Closes the network connection and socket in TCP mode */
static void modbus_close_tcp(modbus_param_t *mb_param)
{
shutdown(mb_param->fd, SHUT_RDWR);
close(mb_param->fd);
}
/* Closes a modbus connection */
void modbus_close(modbus_param_t *mb_param)
{
if (mb_param->type_com == RTU)
modbus_close_rtu(mb_param);
else
modbus_close_tcp(mb_param);
}
/* Activates the debug messages */
void modbus_set_debug(modbus_param_t *mb_param, int boolean)
{
mb_param->debug = boolean;
}