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
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
use zencan_common::{
objects::{DataType, ObjectId, SubInfo},
sdo::{AbortCode, SdoRequest, SdoResponse},
};
use crate::object_dict::{find_object_entry, ODEntry};
use crate::sdo_server::{sdo_comms::ReceiverState, SdoComms};
/// Size of block transfers Always support max of 127 segments in block transfers. This may have to
/// adjust to support configurable buffer size
const BLKSIZE: u8 = 127;
/// Number of microseconds to wait for a message before timing out an SDO transaction
const SDO_TIMEOUT_US: u32 = 25000;
fn validate_download_size(dl_size: usize, subobj: &SubInfo) -> Result<(), AbortCode> {
if subobj.size == 0 {
// Some objects (e.g. domains) do not provide a size, and we simply must write to them and
// see if it fails. These objects report a size of 0.
return Ok(());
}
if subobj.data_type.is_str() || matches!(subobj.data_type, DataType::Domain) {
// Strings can write shorter lengths
if dl_size > subobj.size {
return Err(AbortCode::DataTypeMismatchLengthHigh);
}
} else {
// All other types require exact size
if dl_size < subobj.size {
return Err(AbortCode::DataTypeMismatchLengthLow);
} else if dl_size > subobj.size {
return Err(AbortCode::DataTypeMismatchLengthHigh);
}
}
Ok(())
}
struct SdoResult<'a> {
tx_pending: bool,
response: Option<SdoResponse>,
updated_object: Option<ObjectId>,
new_state: SdoState<'a>,
}
impl<'a> SdoResult<'a> {
fn block_segments_queued(new_state: SdoState<'a>) -> Self {
Self {
tx_pending: true,
response: None,
updated_object: None,
new_state,
}
}
fn no_response(new_state: SdoState<'a>) -> Self {
Self {
tx_pending: false,
response: None,
updated_object: None,
new_state,
}
}
fn abort(index: u16, sub: u8, abort_code: AbortCode) -> Self {
Self {
tx_pending: true,
response: Some(SdoResponse::abort(index, sub, abort_code)),
updated_object: None,
new_state: SdoState::Idle,
}
}
fn response(response: SdoResponse, new_state: SdoState<'a>) -> Self {
Self {
tx_pending: true,
response: Some(response),
updated_object: None,
new_state,
}
}
fn response_with_update(
response: SdoResponse,
index: u16,
sub: u8,
new_state: SdoState<'a>,
) -> Self {
Self {
tx_pending: true,
response: Some(response),
updated_object: Some(ObjectId { index, sub }),
new_state,
}
}
}
#[derive(Clone, Copy)]
struct Segmented<'a> {
object: &'a ODEntry<'a>,
sub: u8,
toggle_state: bool,
segment_counter: u32,
bytes_in_buffer: Option<u32>,
}
#[derive(Clone, Copy)]
struct DownloadBlock<'a> {
sub: u8,
last_segment: u8,
crc: Option<crc16::State<crc16::XMODEM>>,
block_counter: usize,
object: &'a ODEntry<'a>,
}
#[derive(Clone, Copy)]
struct UploadBlock<'a> {
object: &'a ODEntry<'a>,
sent_counter: usize,
last_subblock_size: usize,
crc: Option<crc16::State<crc16::XMODEM>>,
sub: u8,
blksize: u8,
}
enum SdoState<'a> {
Idle,
DownloadSegmented(Segmented<'a>),
UploadSegmented(Segmented<'a>),
DownloadBlock(DownloadBlock<'a>),
EndDownloadBlock(DownloadBlock<'a>),
InitiateUploadBlock(UploadBlock<'a>),
UploadBlock(UploadBlock<'a>),
}
fn copy_upload_sublock(
rx: &SdoComms,
obj: &ODEntry,
crc: Option<&mut crc16::State<crc16::XMODEM>>,
sub: u8,
blksize: u8,
offset: usize,
) -> Result<(usize, bool), AbortCode> {
let mut full_buf = rx.borrow_buffer();
let len = full_buf.len();
// Limit buffer to be the size of a block, and fail if the buffer is not big enough
// for the requested block size. CANOpen doesn't seem to really offer a fallback
// option for sending smaller blocks.
if blksize as usize * 7 > len {
return Err(AbortCode::InvalidBlockSize);
}
let buf = &mut full_buf[0..blksize as usize * 7];
let read_size = obj.data.read(sub, offset, buf)?;
// Start the CRC calculations
if let Some(crc) = crc {
crc.update(&buf[..read_size])
}
// If read size is less than the buffer length then the read is atomic and we
// can safely report the size of the read up front. If it is equal, then the
// read may be longer and we do not report the size up front because it may
// change in the interim. We can't achieve atomic reads for sub objects that are
// larger than the buffer, and so the read size may change. If large objects are
// written during an SDO transfer, it is possible for the client to receive a
// torn read, which is some combination of multiple values.
let complete = read_size != buf.len();
Ok((read_size, complete))
}
impl<'a> SdoState<'a> {
pub fn update(&self, rx: &SdoComms, elapsed_us: u32, od: &'a [ODEntry<'a>]) -> SdoResult<'a> {
match self {
SdoState::Idle => Self::idle(od, rx),
SdoState::DownloadSegmented(state) => Self::download_segmented(state, rx, elapsed_us),
SdoState::UploadSegmented(state) => Self::upload_segmented(state, rx, elapsed_us),
SdoState::DownloadBlock(state) => Self::download_block(state, rx, elapsed_us),
SdoState::EndDownloadBlock(state) => Self::end_download_block(state, rx, elapsed_us),
SdoState::InitiateUploadBlock(state) => {
Self::initiate_upload_block(*state, rx, elapsed_us)
}
SdoState::UploadBlock(state) => Self::upload_block(*state, rx, elapsed_us),
}
}
fn idle(od: &'a [ODEntry<'a>], rx: &SdoComms) -> SdoResult<'a> {
let req = match rx.take_request() {
Some(req) => req,
None => return SdoResult::no_response(SdoState::Idle),
};
match req {
SdoRequest::InitiateDownload {
n,
e,
s,
index,
sub,
data,
} => {
let od_entry = match find_object_entry(od, index) {
Some(x) => x,
None => return SdoResult::abort(index, sub, AbortCode::NoSuchObject),
};
let obj = &od_entry.data;
let subinfo = match obj.sub_info(sub) {
Ok(s) => s,
Err(abort_code) => return SdoResult::abort(index, sub, abort_code),
};
if e {
// Doing an expedited download
// Verify that the requested object is writable
if !subinfo.access_type.is_writable() {
return SdoResult::abort(index, sub, AbortCode::ReadOnly);
}
// Verify data size requested by client fits object, and abort if not
let dl_size = 4 - n as usize;
if let Err(abort_code) = validate_download_size(dl_size, &subinfo) {
return SdoResult::abort(index, sub, abort_code);
}
if let Err(abort_code) = obj.write(sub, &data[0..dl_size]) {
return SdoResult::abort(index, sub, abort_code);
}
SdoResult::response_with_update(
SdoResponse::download_acknowledge(index, sub),
index,
sub,
SdoState::Idle,
)
} else {
// starting a segmented download
// If size is provided, verify data size requested by client fits object, and
// abort if not
if s {
let dl_size = u32::from_le_bytes(data) as usize;
if let Err(abort_code) = validate_download_size(dl_size, &subinfo) {
return SdoResult::abort(index, sub, abort_code);
}
}
let new_state = SdoState::DownloadSegmented(Segmented {
object: od_entry,
sub,
toggle_state: false,
segment_counter: 0,
bytes_in_buffer: Some(0),
});
SdoResult::response(SdoResponse::download_acknowledge(index, sub), new_state)
}
}
SdoRequest::InitiateUpload { index, sub } => {
let od_entry = match find_object_entry(od, index) {
Some(x) => x,
None => return SdoResult::abort(index, sub, AbortCode::NoSuchObject),
};
let obj = od_entry.data;
let mut full_buf = rx.borrow_buffer();
let len = full_buf.len();
// Limit buffer to be a multiple of segment size
let buf = &mut full_buf[0..len - (len % 7)];
let read_size = match obj.read(sub, 0, buf) {
Ok(s) => s,
Err(abort_code) => return SdoResult::abort(index, sub, abort_code),
};
if read_size <= 4 {
// Do expedited upload
SdoResult::response(
SdoResponse::expedited_upload(index, sub, &buf[..read_size]),
SdoState::Idle,
)
} else {
// Start a segmented upload
// If read size is less than the buffer length then the read is atomic and we
// can safely report the size of the read up front. If it is equal, then the
// read may be longer and we do not report the size up front because it may
// change in the interim. We can't achieve atomic reads for sub objects that are
// larger than the buffer, and so the read size may change. If large objects are
// written during an SDO transfer, it is possible for the client to receive a
// torn read, which is some combination of multiple values.
let ack_size = if read_size == buf.len() {
None
} else {
Some(read_size as u32)
};
SdoResult::response(
SdoResponse::upload_acknowledge(index, sub, ack_size),
SdoState::UploadSegmented(Segmented {
object: od_entry,
sub,
toggle_state: false,
segment_counter: 0,
bytes_in_buffer: ack_size,
}),
)
}
}
SdoRequest::InitiateBlockDownload {
cc,
s,
index,
sub,
size,
} => {
// starting a block download
let od_entry = match find_object_entry(od, index) {
Some(x) => x,
None => return SdoResult::abort(index, sub, AbortCode::NoSuchObject),
};
let subinfo = match od_entry.data.sub_info(sub) {
Ok(s) => s,
Err(abort_code) => return SdoResult::abort(index, sub, abort_code),
};
// If size is provided, verify data size requested by client fits object, and
// abort if not
if s {
if let Err(abort_code) = validate_download_size(size as usize, &subinfo) {
return SdoResult::abort(index, sub, abort_code);
}
}
let crc = if cc {
Some(crc16::State::<crc16::XMODEM>::new())
} else {
None
};
rx.begin_block_download(BLKSIZE);
SdoResult::response(
SdoResponse::block_download_acknowledge(true, index, sub, BLKSIZE),
SdoState::DownloadBlock(DownloadBlock {
object: od_entry,
sub,
block_counter: 0,
last_segment: 0,
crc,
}),
)
}
SdoRequest::InitiateBlockUpload {
index,
sub,
cc,
blksize,
pst: _,
} => {
let od_entry = match find_object_entry(od, index) {
Some(x) => x,
None => return SdoResult::abort(index, sub, AbortCode::NoSuchObject),
};
let crc = if cc {
Some(crc16::State::<crc16::XMODEM>::new())
} else {
None
};
SdoResult::response(
SdoResponse::block_upload_acknowledge(index, true, sub, None),
SdoState::InitiateUploadBlock(UploadBlock {
sub,
crc,
last_subblock_size: 0,
sent_counter: 0,
object: od_entry,
blksize,
}),
)
}
_ => SdoResult::abort(0, 0, AbortCode::InvalidCommandSpecifier),
}
}
fn download_segmented(state: &Segmented<'a>, rx: &SdoComms, elapsed_us: u32) -> SdoResult<'a> {
let req = match rx.take_request() {
Some(req) => req,
None => {
let time = rx.increment_timer(elapsed_us);
if time > SDO_TIMEOUT_US {
return SdoResult::abort(state.object.index, state.sub, AbortCode::SdoTimeout);
} else {
return SdoResult::no_response(SdoState::DownloadSegmented(*state));
}
}
};
match req {
SdoRequest::DownloadSegment { t, n, c, data } => {
if t != state.toggle_state {
return SdoResult::abort(
state.object.index,
state.sub,
AbortCode::ToggleNotAlternated,
);
}
let obj = &state.object.data;
let mut buf = rx.borrow_buffer();
// Offset into the objec
let total_offset = state.segment_counter as usize * 7;
// Offset into the current buffer
let buffer_offset = total_offset % buf.len();
let on_first_buffer = total_offset == buffer_offset;
let segment_size = 7 - n as usize;
let copy_len = segment_size.min(buf.len() - buffer_offset);
buf[buffer_offset..buffer_offset + copy_len].copy_from_slice(&data[0..copy_len]);
let buffer_full = buffer_offset + copy_len == buf.len();
let more_bytes_in_message = copy_len < segment_size;
// See if we need to make this a partial write
if buffer_full && (!c || more_bytes_in_message) {
if on_first_buffer {
if let Err(abort_code) = obj.begin_partial(state.sub) {
return SdoResult::abort(state.object.index, state.sub, abort_code);
}
}
if let Err(abort_code) = obj.write_partial(state.sub, &buf) {
return SdoResult::abort(state.object.index, state.sub, abort_code);
}
if more_bytes_in_message {
buf[0..segment_size - copy_len]
.copy_from_slice(&data[copy_len..segment_size]);
}
}
if c {
// See if we already opened a partial write
if (buffer_full && more_bytes_in_message) || !on_first_buffer {
if more_bytes_in_message {
if let Err(abort_code) =
obj.write_partial(state.sub, &buf[0..segment_size - copy_len])
{
return SdoResult::abort(state.object.index, state.sub, abort_code);
}
} else if let Err(abort_code) =
obj.write_partial(state.sub, &buf[..buffer_offset + segment_size])
{
return SdoResult::abort(state.object.index, state.sub, abort_code);
}
if let Err(abort_code) = obj.end_partial(state.sub) {
return SdoResult::abort(state.object.index, state.sub, abort_code);
}
} else if let Err(abort_code) =
obj.write(state.sub, &buf[0..buffer_offset + segment_size])
{
return SdoResult::abort(state.object.index, state.sub, abort_code);
}
SdoResult::response_with_update(
SdoResponse::download_segment_acknowledge(state.toggle_state),
state.object.index,
state.sub,
SdoState::Idle,
)
} else {
// Segments that didn't fit in the buffer get stored to beginning of new buffer
if copy_len < segment_size {
buf[0..segment_size - copy_len]
.copy_from_slice(&data[copy_len..segment_size]);
}
// More segments remaining to be received
let new_state = SdoState::DownloadSegmented(Segmented {
toggle_state: !state.toggle_state,
segment_counter: state.segment_counter + 1,
..*state
});
SdoResult::response(
SdoResponse::download_segment_acknowledge(state.toggle_state),
new_state,
)
}
}
SdoRequest::Abort {
index: _,
sub: _,
abort_code: _,
} => SdoResult::no_response(SdoState::Idle),
_ => SdoResult::abort(
state.object.index,
state.sub,
AbortCode::InvalidCommandSpecifier,
),
}
}
fn upload_segmented(state: &Segmented<'a>, rx: &SdoComms, elapsed_us: u32) -> SdoResult<'a> {
let req = match rx.take_request() {
Some(req) => req,
None => {
let time = rx.increment_timer(elapsed_us);
if time > SDO_TIMEOUT_US {
return SdoResult::abort(state.object.index, state.sub, AbortCode::SdoTimeout);
} else {
return SdoResult::no_response(SdoState::UploadSegmented(*state));
}
}
};
match req {
SdoRequest::ReqUploadSegment { t } => {
if t != state.toggle_state {
return SdoResult::abort(
state.object.index,
state.sub,
AbortCode::ToggleNotAlternated,
);
}
let mut full_buf = rx.borrow_buffer();
let len = full_buf.len();
// Limit buffer to be a multiple of segment size
let buf = &mut full_buf[0..len - (len % 7)];
// How far into the object data we are
let total_read_offset = state.segment_counter as usize * 7;
// How far into the current buffer we are
let buf_read_offset = total_read_offset % buf.len();
let segment_size = if let Some(bytes_in_buffer) = state.bytes_in_buffer {
bytes_in_buffer as usize - buf_read_offset
} else {
buf.len() - buf_read_offset
}
.min(7);
let mut msg_buf = [0; 7];
msg_buf[..segment_size]
.copy_from_slice(&buf[buf_read_offset..buf_read_offset + segment_size]);
let mut c = false;
let mut bytes_in_buffer = state.bytes_in_buffer;
if state.bytes_in_buffer.is_none() {
if buf_read_offset + segment_size == buf.len() {
// We completed the buffered data. Read again to see if there is more data
// to send
let read_size = state
.object
.data
.read(state.sub, total_read_offset + segment_size, buf)
.unwrap();
if read_size == 0 {
// No further data in object, this is the last segment
c = true;
} else {
// We read more data. If the buffer was not filled, this is the last of
// it.
if read_size != buf.len() {
bytes_in_buffer = Some(read_size as u32)
}
}
}
} else {
// This segment finished the bytes in this buffer
if buf_read_offset + segment_size == bytes_in_buffer.unwrap() as usize {
c = true;
}
}
let new_state = if c {
SdoState::Idle
} else {
SdoState::UploadSegmented(Segmented {
object: state.object,
sub: state.sub,
toggle_state: !state.toggle_state,
segment_counter: state.segment_counter + 1,
bytes_in_buffer,
})
};
SdoResult::response(
SdoResponse::upload_segment(state.toggle_state, c, &msg_buf[0..segment_size]),
new_state,
)
}
SdoRequest::Abort {
index: _,
sub: _,
abort_code: _,
} => SdoResult::no_response(SdoState::Idle),
_ => SdoResult::abort(
state.object.index,
state.sub,
AbortCode::InvalidCommandSpecifier,
),
}
}
fn download_block(state: &DownloadBlock<'a>, rx: &SdoComms, elapsed_us: u32) -> SdoResult<'a> {
// During block download, up to 127 block segments are sent out in rapid succession, without
// any acknowledgement, so the processing of these is handled in the receiver. Here, we wait
// for the receiver to signal the completion of a block
match rx.state() {
ReceiverState::Normal => {
// Remove the request from the mailbox
let _ = rx.take_request();
SdoResult::no_response(SdoState::Idle)
}
ReceiverState::BlockReceive => {
// Still waiting. Check timeout.
let time = rx.increment_timer(elapsed_us);
if time > SDO_TIMEOUT_US {
rx.set_state(ReceiverState::Normal);
SdoResult::abort(state.object.index, state.sub, AbortCode::SdoTimeout)
} else {
SdoResult::no_response(SdoState::DownloadBlock(*state))
}
}
ReceiverState::BlockReceiveCompleted {
ackseq,
last_segment,
complete,
} => {
// Some segment was missed, ask for retransmission
// TODO: Request only the segments after ackseq instead of all of them
if ackseq != last_segment {
rx.restart_block_download(ackseq);
SdoResult::response(
SdoResponse::ConfirmBlock {
ackseq,
blksize: BLKSIZE,
},
SdoState::DownloadBlock(*state),
)
} else {
let new_state = if complete {
// This is the last block, but we can't do anything with it until we get the
// end block transfer request because we don't know how many bytes are
// invalid on the last segment
rx.set_state(ReceiverState::Normal);
SdoState::EndDownloadBlock(DownloadBlock {
block_counter: state.block_counter + 1,
last_segment,
..*state
})
} else {
// Store the data from this block
let write_length = last_segment as usize * 7;
let buf = rx.borrow_buffer();
let valid_data = &buf[..write_length];
// Update the running CRC
let mut crc = state.crc;
if let Some(crc) = crc.as_mut() {
crc.update(valid_data);
}
// If this is the first block of a multi-part block transfer, we begin
// partial write now. Not all objects support partial write, although
// generally any object large enough to warrant a multi-block transfer
// probably should.
if state.block_counter == 0 {
if let Err(abort_code) = state.object.data.begin_partial(state.sub) {
rx.set_state(ReceiverState::Normal);
return SdoResult::abort(state.object.index, state.sub, abort_code);
}
}
// Attempt to write the block. It may fail if, for example, the data exceeds
// the size of the object
if let Err(abort_code) =
state.object.data.write_partial(state.sub, valid_data)
{
rx.set_state(ReceiverState::Normal);
return SdoResult::abort(state.object.index, state.sub, abort_code);
}
// Prepare to download a new block
rx.begin_block_download(BLKSIZE);
SdoState::DownloadBlock(DownloadBlock {
block_counter: state.block_counter + 1,
crc,
..*state
})
};
SdoResult::response(
SdoResponse::ConfirmBlock {
ackseq,
blksize: BLKSIZE,
},
new_state,
)
}
}
_ => SdoResult::no_response(SdoState::Idle),
}
}
fn end_download_block(
state: &DownloadBlock<'a>,
rx: &SdoComms,
elapsed_us: u32,
) -> SdoResult<'a> {
let req = match rx.take_request() {
Some(req) => req,
None => {
let time = rx.increment_timer(elapsed_us);
if time > SDO_TIMEOUT_US {
return SdoResult::abort(state.object.index, state.sub, AbortCode::SdoTimeout);
} else {
return SdoResult::no_response(SdoState::EndDownloadBlock(*state));
}
}
};
match req {
SdoRequest::EndBlockDownload { n, crc } => {
let buf = rx.borrow_buffer();
// Safety: If SDO protocol is followed, client cannot be sending
// segments after the last segment, so no segments should be received
// while we hold this shared ref and therefore no mut refs should exist
let write_len = state.last_segment as usize * 7 - n as usize;
let valid_data = &buf[..write_len];
let mut calc_crc = state.crc;
if let Some(calc_crc) = calc_crc.as_mut() {
// Update with the last block
calc_crc.update(valid_data);
// Check CRC
if calc_crc.get() != crc {
return SdoResult::abort(
state.object.index,
state.sub,
AbortCode::CrcError,
);
}
}
let objdata = &state.object.data;
// Store the data from this block
if state.block_counter == 1 {
// We only received a single block, so no partial transfer is required
if let Err(abort_code) = objdata.write(state.sub, valid_data) {
return SdoResult::abort(state.object.index, state.sub, abort_code);
}
} else {
// This is the last block of a multi block transfer write it, and finish
if let Err(abort_code) = objdata.write_partial(state.sub, valid_data) {
return SdoResult::abort(state.object.index, state.sub, abort_code);
}
if let Err(abort_code) = objdata.end_partial(state.sub) {
return SdoResult::abort(state.object.index, state.sub, abort_code);
}
}
SdoResult::response_with_update(
SdoResponse::ConfirmBlockDownloadEnd,
state.object.index,
state.sub,
SdoState::Idle,
)
}
SdoRequest::Abort {
index: _,
sub: _,
abort_code: _,
} => SdoResult::no_response(SdoState::Idle),
_ => SdoResult::abort(
state.object.index,
state.sub,
AbortCode::InvalidCommandSpecifier,
),
}
}
pub fn initiate_upload_block(
mut state: UploadBlock<'a>,
rx: &SdoComms,
elapsed_us: u32,
) -> SdoResult<'a> {
let timer = rx.increment_timer(elapsed_us);
if let Some(req) = rx.take_request() {
match req {
SdoRequest::StartBlockUpload => {
let offset = 0;
let (read_size, send_complete) = match copy_upload_sublock(
rx,
state.object,
state.crc.as_mut(),
state.sub,
state.blksize,
offset,
) {
Ok(result) => result,
Err(abort_code) => {
return SdoResult::abort(state.object.index, state.sub, abort_code)
}
};
rx.begin_block_upload(read_size, send_complete);
SdoResult::block_segments_queued(SdoState::UploadBlock(UploadBlock {
sent_counter: read_size,
last_subblock_size: read_size,
..state
}))
}
SdoRequest::Abort {
index: _,
sub: _,
abort_code: _,
} => SdoResult::no_response(SdoState::Idle),
_ => SdoResult::abort(
state.object.index,
state.sub,
AbortCode::InvalidCommandSpecifier,
),
}
} else if timer > SDO_TIMEOUT_US {
SdoResult::abort(state.object.index, state.sub, AbortCode::SdoTimeout)
} else {
SdoResult::no_response(SdoState::InitiateUploadBlock(state))
}
}
pub fn upload_block(
mut state: UploadBlock<'a>,
rx: &SdoComms,
elapsed_us: u32,
) -> SdoResult<'a> {
let timer = rx.increment_timer(elapsed_us);
match rx.state() {
ReceiverState::BlockSend {
block_size: _,
current_segment: _,
send_complete: _,
} => SdoResult::no_response(SdoState::UploadBlock(state)),
ReceiverState::BlockSendCompleted => {
if let Some(req) = rx.take_request() {
match req {
SdoRequest::ConfirmBlock { ackseq, blksize } => {
let expected_ackseq = state.last_subblock_size.div_ceil(7);
if ackseq != expected_ackseq as u8 {
let offset = state.sent_counter - state.last_subblock_size;
// Failed to receive all blocks. Re-send subblock. Don't recalc CRC.
let (read_size, send_complete) = match copy_upload_sublock(
rx,
state.object,
state.crc.as_mut(),
state.sub,
blksize,
offset,
) {
Ok(result) => result,
Err(abort_code) => {
return SdoResult::abort(
state.object.index,
state.sub,
abort_code,
)
}
};
rx.begin_block_upload(read_size, send_complete);
SdoResult::block_segments_queued(SdoState::UploadBlock(
UploadBlock {
sent_counter: offset,
blksize,
last_subblock_size: state.last_subblock_size,
..state
},
))
} else {
let offset = state.sent_counter;
let (read_size, send_complete) = match copy_upload_sublock(
rx,
state.object,
state.crc.as_mut(),
state.sub,
blksize,
offset,
) {
Ok(result) => result,
Err(abort_code) => {
return SdoResult::abort(
state.object.index,
state.sub,
abort_code,
)
}
};
if read_size > 0 {
rx.begin_block_upload(read_size, send_complete);
SdoResult::block_segments_queued(SdoState::UploadBlock(
UploadBlock {
sent_counter: offset + read_size,
blksize,
last_subblock_size: read_size,
..state
},
))
} else {
rx.set_state(ReceiverState::Normal);
let n = 7 - (state.last_subblock_size % 7) as u8;
SdoResult::response(
SdoResponse::BlockUploadEnd {
n,
crc: state.crc.map(|c| c.get()).unwrap_or(0),
},
SdoState::Idle,
)
}
}
}
SdoRequest::Abort {
index: _,
sub: _,
abort_code: _,
} => {
rx.set_state(ReceiverState::Normal);
SdoResult::no_response(SdoState::Idle)
}
_ => SdoResult::abort(
state.object.index,
state.sub,
AbortCode::InvalidCommandSpecifier,
),
}
} else if timer > SDO_TIMEOUT_US {
SdoResult::abort(state.object.index, state.sub, AbortCode::SdoTimeout)
} else {
SdoResult::no_response(SdoState::UploadBlock(state))
}
}
ReceiverState::BlockSendAborted => todo!(),
_ => SdoResult::abort(
state.object.index,
state.sub,
AbortCode::InvalidCommandSpecifier,
),
}
}
}
/// Implements an SDO server
///
/// A single SDO server can be controlled by a single SDO client (at one time). This struct wraps up
/// the state and implements handling of SDO requests. A node implementing multiple SDO servers can
/// instantiate multiple instances of `SdoServer` to track each.
pub(crate) struct SdoServer<'a> {
state: SdoState<'a>,
}
impl<'a> SdoServer<'a> {
/// Create a new SDO server
pub fn new() -> Self {
Self {
state: SdoState::Idle,
}
}
/// Handle incoming SDO requests
///
/// This will process the request, update server state and the object dictionary accordingly,
/// and return a response to be transmitted back to the client, as well the index of the updated
/// object when a download is completed.
pub fn process(
&mut self,
comms: &SdoComms,
elapsed_us: u32,
od: &'a [ODEntry<'a>],
) -> (bool, Option<ObjectId>) {
let result = self.state.update(comms, elapsed_us, od);
self.state = result.new_state;
if let Some(resp) = result.response {
comms.store_response(resp);
}
(result.tx_pending, result.updated_object)
}
}
#[cfg(test)]
mod tests {
use crate::object_dict::{
find_object, ByteField, ConstField, NullTermByteField, ObjectAccess as _,
ProvidesSubObjects, SubObjectAccess,
};
use zencan_common::{
objects::{AccessType, DataType, ObjectCode},
sdo::BlockSegment,
};
use crate::SDO_BUFFER_SIZE;
use super::*;
const SUB1_SIZE: usize = 1200;
const SUB2_SIZE: usize = 78;
struct Object1000 {
sub1: NullTermByteField<SUB1_SIZE>,
sub2: ByteField<SUB2_SIZE>,
}
impl ProvidesSubObjects for Object1000 {
fn get_sub_object(&self, sub: u8) -> Option<(SubInfo, &dyn SubObjectAccess)> {
match sub {
0 => Some((
SubInfo::MAX_SUB_NUMBER,
const { &ConstField::new(1u8.to_le_bytes()) },
)),
1 => Some((
SubInfo {
size: self.sub1.len(),
data_type: DataType::VisibleString,
access_type: AccessType::Rw,
..Default::default()
},
&self.sub1,
)),
2 => Some((
SubInfo {
size: self.sub2.len(),
data_type: DataType::OctetString,
access_type: AccessType::Rw,
..Default::default()
},
&self.sub2,
)),
_ => None,
}
}
fn object_code(&self) -> ObjectCode {
ObjectCode::Record
}
}
struct TestOd {
pub object1000: &'static Object1000,
pub table: &'static [ODEntry<'static>; 1],
}
fn test_od() -> TestOd {
let object1000 = Box::leak(Box::new(Object1000 {
sub1: NullTermByteField::new([0; 1200]),
sub2: ByteField::new([0; SUB2_SIZE]),
}));
let table = Box::leak(Box::new([ODEntry {
index: 0x1000,
data: object1000,
}]));
TestOd { object1000, table }
}
fn do_happy_block_download(
server: &mut SdoServer,
rx: &SdoComms,
od: &'static [ODEntry<'static>],
size: usize,
) {
const INDEX: u16 = 0x1000;
const SUB: u8 = 1;
let mut round_trip = |msg_data: [u8; 8], elapsed| {
rx.handle_req(&msg_data);
let (_, update_index) = server.process(rx, elapsed, od);
let resp: Option<SdoResponse> = rx
.next_transmit_message()
.map(|data| data.try_into().unwrap());
(resp, update_index)
};
let msg = SdoRequest::initiate_block_download(INDEX, SUB, true, size as u32).to_bytes();
let (resp, index) = round_trip(msg, 0);
assert_eq!(
resp,
Some(SdoResponse::ConfirmBlockDownload {
sc: true,
index: INDEX,
sub: SUB,
blksize: 127
})
);
assert_eq!(None, index);
let mut pos = 0;
let mut seqnum = 0;
let data = Vec::from_iter((0..size).map(|x| ((x % 256) as u8).max(1)));
let crc = crc16::State::<crc16::XMODEM>::calculate(&data);
while pos < size {
let len = (size - pos).min(7);
let mut chunk = [0; 7];
chunk[0..len].copy_from_slice(&data[pos..pos + len]);
pos += len;
seqnum += 1;
let c = pos == size;
let msg = BlockSegment {
c,
seqnum,
data: chunk.try_into().unwrap(),
}
.to_bytes();
let (resp, index) = round_trip(msg, 0);
if c {
assert_eq!(
Some(SdoResponse::ConfirmBlock {
ackseq: seqnum,
blksize: 127
}),
resp
);
} else if seqnum == 127 {
// start a new block
seqnum = 0;
assert_eq!(
Some(SdoResponse::ConfirmBlock {
ackseq: 127,
blksize: 127
}),
resp
);
} else {
assert_eq!(None, resp);
}
assert_eq!(None, index);
}
let n = ((7 - size % 7) % 7) as u8;
let msg = SdoRequest::end_block_download(n, crc).to_bytes();
let (resp, index) = round_trip(msg, 0);
assert_eq!(Some(SdoResponse::ConfirmBlockDownloadEnd), resp);
assert_eq!(
Some(ObjectId {
index: INDEX,
sub: SUB
}),
index
);
let mut read_buf = vec![0u8; size];
od[0].data.read(SUB, 0, &mut read_buf).unwrap();
assert_eq!(data, read_buf);
}
#[test]
fn test_block_download() {
let buffer = Box::leak(Box::new([0; SDO_BUFFER_SIZE]));
let mut server = SdoServer::new();
let comms = SdoComms::new(buffer);
let od = test_od();
println!("Running 128 byte download");
do_happy_block_download(&mut server, &comms, od.table, 128);
println!("Running 1200 byte download");
do_happy_block_download(&mut server, &comms, od.table, 1200);
}
#[test]
fn test_block_download_missing_block() {
let buffer = Box::leak(Box::new([0; SDO_BUFFER_SIZE]));
let mut server = SdoServer::new();
let comms = SdoComms::new(buffer);
let od = test_od();
const INDEX: u16 = 0x1000;
const SUB: u8 = 1;
const DATA_SIZE: usize = 7 * 3;
let mut round_trip = |msg_data: [u8; 8], elapsed| {
comms.handle_req(&msg_data);
let (_, update_index) = server.process(&comms, elapsed, od.table);
let resp: Option<SdoResponse> = comms
.next_transmit_message()
.map(|data| data.try_into().unwrap());
(resp, update_index)
};
let mut data = [0; DATA_SIZE];
for i in 0..DATA_SIZE {
data[i] = i as u8;
}
// Initiate the transfer
let msg =
SdoRequest::initiate_block_download(INDEX, SUB, true, DATA_SIZE as u32).to_bytes();
let (resp, index) = round_trip(msg, 0);
assert_eq!(
resp,
Some(SdoResponse::ConfirmBlockDownload {
sc: true,
index: INDEX,
sub: SUB,
blksize: 127
})
);
assert_eq!(None, index);
// Send the first block, and the third block, skipping the second block
let (resp, index) = round_trip(
BlockSegment {
c: false,
seqnum: 1,
data: data[0..7].try_into().unwrap(),
}
.to_bytes(),
0,
);
assert_eq!(None, resp);
assert_eq!(None, index);
let (resp, index) = round_trip(
BlockSegment {
c: true,
seqnum: 3,
data: data[14..21].try_into().unwrap(),
}
.to_bytes(),
0,
);
assert_eq!(
Some(SdoResponse::ConfirmBlock {
ackseq: 1,
blksize: 127
}),
resp
);
assert_eq!(None, index);
// Retransmit the last two blocks
let (resp, index) = round_trip(
BlockSegment {
c: false,
seqnum: 2,
data: data[7..14].try_into().unwrap(),
}
.to_bytes(),
0,
);
assert_eq!(None, resp);
assert_eq!(None, index);
let (resp, index) = round_trip(
BlockSegment {
c: true,
seqnum: 3,
data: data[14..21].try_into().unwrap(),
}
.to_bytes(),
0,
);
assert_eq!(
Some(SdoResponse::ConfirmBlock {
ackseq: 3,
blksize: 127
}),
resp
);
assert_eq!(None, index);
// End the transfer and check the value in the object
let n = ((7 - DATA_SIZE % 7) % 7) as u8;
let crc = crc16::State::<crc16::XMODEM>::calculate(&data);
let msg = SdoRequest::end_block_download(n, crc).to_bytes();
let (resp, index) = round_trip(msg, 0);
assert_eq!(Some(SdoResponse::ConfirmBlockDownloadEnd), resp);
assert_eq!(
Some(ObjectId {
index: INDEX,
sub: SUB
}),
index
);
let mut read_buf = vec![0u8; DATA_SIZE];
od.object1000.read(SUB, 0, &mut read_buf).unwrap();
assert_eq!(data.as_slice(), read_buf);
}
#[test]
fn test_block_download_timeout() {
let buffer = Box::leak(Box::new([0; SDO_BUFFER_SIZE]));
let mut server = SdoServer::new();
let comms = SdoComms::new(buffer);
let od = test_od();
const INDEX: u16 = 0x1000;
const SUB: u8 = 1;
const DATA_SIZE: usize = 7 * 3;
let mut round_trip = |msg_data: Option<[u8; 8]>, elapsed| {
if let Some(msg_data) = msg_data {
comms.handle_req(&msg_data);
}
let (_, update_index) = server.process(&comms, elapsed, od.table);
let resp: Option<SdoResponse> = comms
.next_transmit_message()
.map(|data| data.try_into().unwrap());
(resp, update_index)
};
let mut data = [0; DATA_SIZE];
for i in 0..DATA_SIZE {
data[i] = i as u8;
}
// Start transfer
let (resp, index) = round_trip(
Some(
SdoRequest::initiate_block_download(INDEX, SUB, true, DATA_SIZE as u32).to_bytes(),
),
0,
);
assert_eq!(
resp,
Some(SdoResponse::ConfirmBlockDownload {
sc: true,
index: INDEX,
sub: SUB,
blksize: 127
})
);
assert_eq!(None, index);
// After a small amount of time, we should have no response
let (resp, index) = round_trip(None, 1000);
assert_eq!(None, resp);
assert_eq!(None, index);
// After a long time, it should time out and send an abort
let (resp, index) = round_trip(None, 1000000);
assert_eq!(
Some(SdoResponse::Abort {
index: INDEX,
sub: SUB,
abort_code: AbortCode::SdoTimeout as u32
}),
resp
);
assert_eq!(None, index);
}
#[test]
fn test_block_upload() {
let buffer = Box::leak(Box::new([0; SDO_BUFFER_SIZE]));
let mut server = SdoServer::new();
let comms = SdoComms::new(buffer);
let od = test_od();
const INDEX: u16 = 0x1000;
const SUB: u8 = 1;
// Create a counting pattern to store in the object and readback
let write_data: [u8; SUB1_SIZE] = core::array::from_fn(|i| (i as u8).max(1));
od.object1000.write(SUB, &write_data).unwrap();
let mut round_trip = |msg_data: Option<[u8; 8]>, elapsed| {
if let Some(msg_data) = msg_data {
comms.handle_req(&msg_data);
}
let (_, update_index) = server.process(&comms, elapsed, od.table);
let resp: Option<SdoResponse> = comms
.next_transmit_message()
.map(|data| data.try_into().unwrap());
assert_eq!(None, update_index);
resp
};
const BLKSIZE: u8 = 127;
const PST: u8 = 0;
const CC: bool = true; // Client supports CRC
let resp = round_trip(
Some(SdoRequest::initiate_block_upload(INDEX, SUB, CC, BLKSIZE, PST).to_bytes()),
0,
);
let (expect_s, expect_size) = if write_data.len() < SDO_BUFFER_SIZE {
(true, SUB1_SIZE as u32)
} else {
(false, 0)
};
assert_eq!(
Some(SdoResponse::ConfirmBlockUpload {
sc: true,
s: expect_s,
index: INDEX,
sub: SUB,
size: expect_size,
}),
resp
);
// Send the start block command -- no response is expected other than sending block data
comms.handle_req(&SdoRequest::StartBlockUpload.to_bytes());
server.process(&comms, 0, od.table);
let mut receive_a_block = |size: usize, last_block: bool, block_expect_data: &[u8]| {
let num_segments = ((size as f64) / 7.0).ceil() as usize;
for i in 0..num_segments {
println!("Expecting segment {}", i + 1);
let tx_msg = comms.next_transmit_message();
let exp_c = last_block && i == num_segments - 1;
let mut expect_data = [0; 7];
let segment_size = (size - i * 7).min(7);
expect_data[..segment_size]
.copy_from_slice(&block_expect_data[i * 7..i * 7 + segment_size]);
assert_eq!(
BlockSegment {
c: exp_c,
seqnum: (i + 1) as u8,
data: expect_data
},
BlockSegment::try_from(tx_msg.unwrap().as_slice()).unwrap()
);
}
comms.handle_req(
&SdoRequest::ConfirmBlock {
ackseq: num_segments as u8,
blksize: BLKSIZE,
}
.to_bytes(),
);
server.process(&comms, 0, od.table);
};
let num_blocks = (write_data.len() + BLKSIZE as usize * 7 - 1) / (BLKSIZE as usize * 7);
for i in 0..num_blocks {
let start_idx = i * BLKSIZE as usize * 7;
let block_size = (write_data.len() - start_idx).min(BLKSIZE as usize * 7);
let last_block = i == num_blocks - 1;
receive_a_block(
block_size,
last_block,
&write_data[start_idx..start_idx + block_size],
);
}
server.process(&comms, 0, od.table);
let expect_n = 7 - (write_data.len() % 7) as u8;
let expect_crc = crc16::State::<crc16::XMODEM>::calculate(&write_data);
let msg = comms.next_transmit_message();
assert_eq!(
Some(
SdoResponse::BlockUploadEnd {
n: expect_n,
crc: expect_crc
}
.to_bytes(),
),
msg
);
}
/// Test uploading a value with a length of 7
#[test]
fn test_segmented_download() {
const SDO_BUFFER_SIZE: usize = 32;
let buffer = Box::leak(Box::new([0; SDO_BUFFER_SIZE]));
let mut server = SdoServer::new();
let comms = SdoComms::new(buffer);
let od = test_od();
const INDEX: u16 = 0x1000;
const SUB: u8 = 2;
let mut round_trip = |msg_data: Option<[u8; 8]>, elapsed| {
if let Some(msg_data) = msg_data {
comms.handle_req(&msg_data);
}
let (_, update_index) = server.process(&comms, elapsed, od.table);
let resp: Option<SdoResponse> = comms
.next_transmit_message()
.map(|data| data.try_into().unwrap());
(resp, update_index)
};
let mut do_segmented_download = |size: usize| {
let write_data = Vec::from_iter((0..size).map(|x| x as u8));
let mut toggle = false;
let mut sent_bytes = 0;
let (resp, index) = round_trip(
Some(SdoRequest::initiate_download(INDEX, SUB, Some(7)).to_bytes()),
0,
);
assert_eq!(None, index);
assert_eq!(
Some(SdoResponse::ConfirmDownload {
index: INDEX,
sub: SUB
}),
resp
);
// Insert an extra process call with no data. This should be a NOOP.
let (resp, index) = round_trip(None, 0);
assert_eq!(None, resp);
assert_eq!(None, index);
while sent_bytes < write_data.len() {
let bytes_left = write_data.len() - sent_bytes;
let bytes_to_send = bytes_left.min(7);
let complete = bytes_left <= bytes_to_send;
let (resp, index) = round_trip(
Some(
SdoRequest::download_segment(
toggle,
complete,
&write_data[sent_bytes..sent_bytes + bytes_to_send],
)
.to_bytes(),
),
0,
);
assert_eq!(
Some(SdoResponse::ConfirmDownloadSegment { t: toggle }),
resp
);
if complete {
assert_eq!(
Some(ObjectId {
index: INDEX,
sub: SUB
}),
index
);
} else {
assert_eq!(None, index);
}
toggle = !toggle;
sent_bytes += bytes_to_send;
}
// Grab the object and read back the data we just wrote
let obj = find_object(od.table, INDEX).unwrap();
let mut read_buf = vec![0; write_data.len()];
let read_size = obj.read(SUB, 0, &mut read_buf).unwrap();
assert_eq!(write_data.len(), read_size);
assert_eq!(write_data, read_buf);
};
// Test downloading a single segment object smaller than segment
do_segmented_download(6);
// Test downloading a 7 byte, single segment object
do_segmented_download(7);
// Test downloading a single segment object just bigger than one segment
do_segmented_download(8);
// Test doing a length equal to the SDO buffer size
do_segmented_download(SDO_BUFFER_SIZE);
// Test doing a length just larger than the buffer
do_segmented_download(SDO_BUFFER_SIZE + 1);
// Tests full object write
do_segmented_download(SUB2_SIZE);
}
#[test]
fn test_segmented_upload() {
const SDO_BUFFER_SIZE: usize = 28;
let buffer = Box::leak(Box::new([0; SDO_BUFFER_SIZE]));
let mut server = SdoServer::new();
let comms = SdoComms::new(buffer);
let od = test_od();
const INDEX: u16 = 0x1000;
const SUB: u8 = 1;
let mut round_trip = |msg_data: Option<[u8; 8]>, elapsed| {
if let Some(msg_data) = msg_data {
comms.handle_req(&msg_data);
}
let (_, update_index) = server.process(&comms, elapsed, od.table);
let resp: Option<SdoResponse> = comms
.next_transmit_message()
.map(|data| data.try_into().unwrap());
(resp, update_index)
};
let mut do_segmented_upload = |size: usize| {
println!("Performing upload of size {size}");
let write_data = Vec::from_iter((0..size).map(|x| (x + 1) as u8));
let mut toggle = false;
let mut rx_count = 0;
// Store the requested size to the object
od.object1000.write(SUB, &write_data).unwrap();
// Initiate read-back
let (resp, index) =
round_trip(Some(SdoRequest::initiate_upload(INDEX, SUB).to_bytes()), 0);
// For reads which are smaller than the SDO buffer, an atomic read is performed and size
// is known at the start of transfer. For larger reads, it is not.
let expected_s = size < SDO_BUFFER_SIZE;
let expected_data = if expected_s {
(size as u32).to_le_bytes()
} else {
[0; 4]
};
assert_eq!(None, index);
assert_eq!(
Some(SdoResponse::ConfirmUpload {
index: INDEX,
sub: SUB,
n: 0,
e: false,
s: expected_s,
data: expected_data,
}),
resp
);
// Insert an extra process call with no data. This should be a NOOP.
let (resp, index) = round_trip(None, 0);
assert_eq!(None, resp);
assert_eq!(None, index);
loop {
let bytes_left = size - rx_count;
let (resp, index) = round_trip(
Some(SdoRequest::upload_segment_request(toggle).to_bytes()),
0,
);
let expected_segment_size = bytes_left.min(7);
let expected_n = 7 - expected_segment_size as u8;
let expected_c = rx_count + expected_segment_size == size;
let mut expected_data = [0; 7];
expected_data[0..expected_segment_size]
.copy_from_slice(&write_data[rx_count..rx_count + expected_segment_size]);
rx_count += expected_segment_size;
assert_eq!(
Some(SdoResponse::UploadSegment {
t: toggle,
n: expected_n,
c: expected_c,
data: expected_data
}),
resp
);
assert_eq!(None, index);
toggle = !toggle;
if expected_c {
break;
}
}
};
// Test downloading a single segment object smaller than segment
do_segmented_upload(6);
// Test downloading a 7 byte, single segment object
do_segmented_upload(7);
// Test downloading a single segment object just bigger than one segment
do_segmented_upload(8);
// Test doing a length equal to the SDO buffer size
do_segmented_upload(SDO_BUFFER_SIZE);
// Test doing a length just larger than the buffer
do_segmented_upload(SDO_BUFFER_SIZE + 1);
}
}