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
|
#include "firmware_update.h"
#include "utils.h"
#include <endian.h>
#include <stdbool.h>
#include <string.h>
/** @brief Check whether string type value is valid
*
* @return true if string type value is valid, false if not
*/
static bool is_string_type_valid(uint8_t string_type)
{
switch (string_type) {
case PLDM_STR_TYPE_UNKNOWN:
return false;
case PLDM_STR_TYPE_ASCII:
case PLDM_STR_TYPE_UTF_8:
case PLDM_STR_TYPE_UTF_16:
case PLDM_STR_TYPE_UTF_16LE:
case PLDM_STR_TYPE_UTF_16BE:
return true;
default:
return false;
}
}
/** @brief Return the length of the descriptor type described in firmware update
* specification
*
* @return length of the descriptor type if descriptor type is valid else
* return 0
*/
static uint16_t get_descriptor_type_length(uint16_t descriptor_type)
{
switch (descriptor_type) {
case PLDM_FWUP_PCI_VENDOR_ID:
return PLDM_FWUP_PCI_VENDOR_ID_LENGTH;
case PLDM_FWUP_IANA_ENTERPRISE_ID:
return PLDM_FWUP_IANA_ENTERPRISE_ID_LENGTH;
case PLDM_FWUP_UUID:
return PLDM_FWUP_UUID_LENGTH;
case PLDM_FWUP_PNP_VENDOR_ID:
return PLDM_FWUP_PNP_VENDOR_ID_LENGTH;
case PLDM_FWUP_ACPI_VENDOR_ID:
return PLDM_FWUP_ACPI_VENDOR_ID_LENGTH;
case PLDM_FWUP_IEEE_ASSIGNED_COMPANY_ID:
return PLDM_FWUP_IEEE_ASSIGNED_COMPANY_ID_LENGTH;
case PLDM_FWUP_SCSI_VENDOR_ID:
return PLDM_FWUP_SCSI_VENDOR_ID_LENGTH;
case PLDM_FWUP_PCI_DEVICE_ID:
return PLDM_FWUP_PCI_DEVICE_ID_LENGTH;
case PLDM_FWUP_PCI_SUBSYSTEM_VENDOR_ID:
return PLDM_FWUP_PCI_SUBSYSTEM_VENDOR_ID_LENGTH;
case PLDM_FWUP_PCI_SUBSYSTEM_ID:
return PLDM_FWUP_PCI_SUBSYSTEM_ID_LENGTH;
case PLDM_FWUP_PCI_REVISION_ID:
return PLDM_FWUP_PCI_REVISION_ID_LENGTH;
case PLDM_FWUP_PNP_PRODUCT_IDENTIFIER:
return PLDM_FWUP_PNP_PRODUCT_IDENTIFIER_LENGTH;
case PLDM_FWUP_ACPI_PRODUCT_IDENTIFIER:
return PLDM_FWUP_ACPI_PRODUCT_IDENTIFIER_LENGTH;
case PLDM_FWUP_ASCII_MODEL_NUMBER_LONG_STRING:
return PLDM_FWUP_ASCII_MODEL_NUMBER_LONG_STRING_LENGTH;
case PLDM_FWUP_ASCII_MODEL_NUMBER_SHORT_STRING:
return PLDM_FWUP_ASCII_MODEL_NUMBER_SHORT_STRING_LENGTH;
case PLDM_FWUP_SCSI_PRODUCT_ID:
return PLDM_FWUP_SCSI_PRODUCT_ID_LENGTH;
case PLDM_FWUP_UBM_CONTROLLER_DEVICE_CODE:
return PLDM_FWUP_UBM_CONTROLLER_DEVICE_CODE_LENGTH;
default:
return 0;
}
}
/** @brief Check whether ComponentResponse is valid
*
* @return true if ComponentResponse is valid, false if not
*/
static bool is_comp_resp_valid(uint8_t comp_resp)
{
switch (comp_resp) {
case PLDM_CR_COMP_CAN_BE_UPDATED:
case PLDM_CR_COMP_MAY_BE_UPDATEABLE:
return true;
default:
return false;
}
}
/** @brief Check whether ComponentResponseCode is valid
*
* @return true if ComponentResponseCode is valid, false if not
*/
static bool is_comp_resp_code_valid(uint8_t comp_resp_code)
{
switch (comp_resp_code) {
case PLDM_CRC_COMP_CAN_BE_UPDATED:
case PLDM_CRC_COMP_COMPARISON_STAMP_IDENTICAL:
case PLDM_CRC_COMP_COMPARISON_STAMP_LOWER:
case PLDM_CRC_INVALID_COMP_COMPARISON_STAMP:
case PLDM_CRC_COMP_CONFLICT:
case PLDM_CRC_COMP_PREREQUISITES_NOT_MET:
case PLDM_CRC_COMP_NOT_SUPPORTED:
case PLDM_CRC_COMP_SECURITY_RESTRICTIONS:
case PLDM_CRC_INCOMPLETE_COMP_IMAGE_SET:
case PLDM_CRC_ACTIVE_IMAGE_NOT_UPDATEABLE_SUBSEQUENTLY:
case PLDM_CRC_COMP_VER_STR_IDENTICAL:
case PLDM_CRC_COMP_VER_STR_LOWER:
return true;
default:
if (comp_resp_code >=
PLDM_CRC_VENDOR_COMP_RESP_CODE_RANGE_MIN &&
comp_resp_code <=
PLDM_CRC_VENDOR_COMP_RESP_CODE_RANGE_MAX) {
return true;
}
return false;
}
}
/** @brief Check whether ComponentCompatibilityResponse is valid
*
* @return true if ComponentCompatibilityResponse is valid, false if not
*/
static bool is_comp_compatibility_resp_valid(uint8_t comp_compatibility_resp)
{
switch (comp_compatibility_resp) {
case PLDM_CCR_COMP_CAN_BE_UPDATED:
case PLDM_CCR_COMP_CANNOT_BE_UPDATED:
return true;
default:
return false;
}
}
/** @brief Check whether ComponentCompatibilityResponse Code is valid
*
* @return true if ComponentCompatibilityResponse Code is valid, false if not
*/
static bool
is_comp_compatibility_resp_code_valid(uint8_t comp_compatibility_resp_code)
{
switch (comp_compatibility_resp_code) {
case PLDM_CCRC_NO_RESPONSE_CODE:
case PLDM_CCRC_COMP_COMPARISON_STAMP_IDENTICAL:
case PLDM_CCRC_COMP_COMPARISON_STAMP_LOWER:
case PLDM_CCRC_INVALID_COMP_COMPARISON_STAMP:
case PLDM_CCRC_COMP_CONFLICT:
case PLDM_CCRC_COMP_PREREQUISITES_NOT_MET:
case PLDM_CCRC_COMP_NOT_SUPPORTED:
case PLDM_CCRC_COMP_SECURITY_RESTRICTIONS:
case PLDM_CRC_INCOMPLETE_COMP_IMAGE_SET:
case PLDM_CCRC_COMP_INFO_NO_MATCH:
case PLDM_CCRC_COMP_VER_STR_IDENTICAL:
case PLDM_CCRC_COMP_VER_STR_LOWER:
return true;
default:
if (comp_compatibility_resp_code >=
PLDM_CCRC_VENDOR_COMP_RESP_CODE_RANGE_MIN &&
comp_compatibility_resp_code <=
PLDM_CCRC_VENDOR_COMP_RESP_CODE_RANGE_MAX) {
return true;
}
return false;
}
}
/** @brief Check whether SelfContainedActivationRequest is valid
*
* @return true if SelfContainedActivationRequest is valid, false if not
*/
static bool
is_self_contained_activation_req_valid(bool8_t self_contained_activation_req)
{
switch (self_contained_activation_req) {
case PLDM_NOT_ACTIVATE_SELF_CONTAINED_COMPONENTS:
case PLDM_ACTIVATE_SELF_CONTAINED_COMPONENTS:
return true;
default:
return false;
}
}
/** @brief Check if current or previous status in GetStatus command response is
* valid
*
* @param[in] state - current or previous different state machine state of
* the FD
* @return true if state is valid, false if not
*/
static bool is_state_valid(uint8_t state)
{
switch (state) {
case PLDM_FD_STATE_IDLE:
case PLDM_FD_STATE_LEARN_COMPONENTS:
case PLDM_FD_STATE_READY_XFER:
case PLDM_FD_STATE_DOWNLOAD:
case PLDM_FD_STATE_VERIFY:
case PLDM_FD_STATE_APPLY:
case PLDM_FD_STATE_ACTIVATE:
return true;
default:
return false;
}
}
/** @brief Check if aux state in GetStatus command response is valid
*
* @param[in] aux_state - provides additional information to the UA to describe
* the current operation state of the FD/FDP
*
* @return true if aux state is valid, false if not
*/
static bool is_aux_state_valid(uint8_t aux_state)
{
switch (aux_state) {
case PLDM_FD_OPERATION_IN_PROGRESS:
case PLDM_FD_OPERATION_SUCCESSFUL:
case PLDM_FD_OPERATION_FAILED:
case PLDM_FD_IDLE_LEARN_COMPONENTS_READ_XFER:
return true;
default:
return false;
}
}
/** @brief Check if aux state status in GetStatus command response is valid
*
* @param[in] aux_state_status - aux state status
*
* @return true if aux state status is valid, false if not
*/
static bool is_aux_state_status_valid(uint8_t aux_state_status)
{
if (aux_state_status == PLDM_FD_AUX_STATE_IN_PROGRESS_OR_SUCCESS ||
aux_state_status == PLDM_FD_TIMEOUT ||
aux_state_status == PLDM_FD_GENERIC_ERROR ||
(aux_state_status >= PLDM_FD_VENDOR_DEFINED_STATUS_CODE_START &&
aux_state_status <= PLDM_FD_VENDOR_DEFINED_STATUS_CODE_END)) {
return true;
}
return false;
}
/** @brief Check if reason code in GetStatus command response is valid
*
* @param[in] reason_code - provides the reason for why the current state
* entered the IDLE state
*
* @return true if reason code is valid, false if not
*/
static bool is_reason_code_valid(uint8_t reason_code)
{
switch (reason_code) {
case PLDM_FD_INITIALIZATION:
case PLDM_FD_ACTIVATE_FW:
case PLDM_FD_CANCEL_UPDATE:
case PLDM_FD_TIMEOUT_LEARN_COMPONENT:
case PLDM_FD_TIMEOUT_READY_XFER:
case PLDM_FD_TIMEOUT_DOWNLOAD:
case PLDM_FD_TIMEOUT_VERIFY:
case PLDM_FD_TIMEOUT_APPLY:
return true;
default:
if (reason_code >= PLDM_FD_STATUS_VENDOR_DEFINED_MIN) {
return true;
}
return false;
}
}
/** @brief Check if non functioning component indication in CancelUpdate
* response is valid
*
* @return true if non functioning component indication is valid, false if not
*/
static bool is_non_functioning_component_indication_valid(
bool8_t non_functioning_component_indication)
{
switch (non_functioning_component_indication) {
case PLDM_FWUP_COMPONENTS_FUNCTIONING:
case PLDM_FWUP_COMPONENTS_NOT_FUNCTIONING:
return true;
default:
return false;
}
}
int decode_pldm_package_header_info(
const uint8_t *data, size_t length,
struct pldm_package_header_information *package_header_info,
struct variable_field *package_version_str)
{
if (data == NULL || package_header_info == NULL ||
package_version_str == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (length < sizeof(struct pldm_package_header_information)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_package_header_information *data_header =
(struct pldm_package_header_information *)(data);
if (!is_string_type_valid(data_header->package_version_string_type) ||
(data_header->package_version_string_length == 0)) {
return PLDM_ERROR_INVALID_DATA;
}
if (length < sizeof(struct pldm_package_header_information) +
data_header->package_version_string_length) {
return PLDM_ERROR_INVALID_LENGTH;
}
if ((data_header->component_bitmap_bit_length %
PLDM_FWUP_COMPONENT_BITMAP_MULTIPLE) != 0) {
return PLDM_ERROR_INVALID_DATA;
}
memcpy(package_header_info->uuid, data_header->uuid,
sizeof(data_header->uuid));
package_header_info->package_header_format_version =
data_header->package_header_format_version;
package_header_info->package_header_size =
le16toh(data_header->package_header_size);
memcpy(package_header_info->package_release_date_time,
data_header->package_release_date_time,
sizeof(data_header->package_release_date_time));
package_header_info->component_bitmap_bit_length =
le16toh(data_header->component_bitmap_bit_length);
package_header_info->package_version_string_type =
data_header->package_version_string_type;
package_header_info->package_version_string_length =
data_header->package_version_string_length;
package_version_str->ptr =
data + sizeof(struct pldm_package_header_information);
package_version_str->length =
package_header_info->package_version_string_length;
return PLDM_SUCCESS;
}
int decode_firmware_device_id_record(
const uint8_t *data, size_t length,
uint16_t component_bitmap_bit_length,
struct pldm_firmware_device_id_record *fw_device_id_record,
struct variable_field *applicable_components,
struct variable_field *comp_image_set_version_str,
struct variable_field *record_descriptors,
struct variable_field *fw_device_pkg_data)
{
if (data == NULL || fw_device_id_record == NULL ||
applicable_components == NULL ||
comp_image_set_version_str == NULL || record_descriptors == NULL ||
fw_device_pkg_data == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (length < sizeof(struct pldm_firmware_device_id_record)) {
return PLDM_ERROR_INVALID_LENGTH;
}
if ((component_bitmap_bit_length %
PLDM_FWUP_COMPONENT_BITMAP_MULTIPLE) != 0) {
return PLDM_ERROR_INVALID_DATA;
}
struct pldm_firmware_device_id_record *data_record =
(struct pldm_firmware_device_id_record *)(data);
if (!is_string_type_valid(
data_record->comp_image_set_version_string_type) ||
(data_record->comp_image_set_version_string_length == 0)) {
return PLDM_ERROR_INVALID_DATA;
}
fw_device_id_record->record_length =
le16toh(data_record->record_length);
fw_device_id_record->descriptor_count = data_record->descriptor_count;
fw_device_id_record->device_update_option_flags.value =
le32toh(data_record->device_update_option_flags.value);
fw_device_id_record->comp_image_set_version_string_type =
data_record->comp_image_set_version_string_type;
fw_device_id_record->comp_image_set_version_string_length =
data_record->comp_image_set_version_string_length;
fw_device_id_record->fw_device_pkg_data_length =
le16toh(data_record->fw_device_pkg_data_length);
if (length < fw_device_id_record->record_length) {
return PLDM_ERROR_INVALID_LENGTH;
}
uint16_t applicable_components_length =
component_bitmap_bit_length /
PLDM_FWUP_COMPONENT_BITMAP_MULTIPLE;
uint16_t calc_min_record_length =
sizeof(struct pldm_firmware_device_id_record) +
applicable_components_length +
data_record->comp_image_set_version_string_length +
PLDM_FWUP_DEVICE_DESCRIPTOR_MIN_LEN +
fw_device_id_record->fw_device_pkg_data_length;
if (fw_device_id_record->record_length < calc_min_record_length) {
return PLDM_ERROR_INVALID_LENGTH;
}
applicable_components->ptr =
data + sizeof(struct pldm_firmware_device_id_record);
applicable_components->length = applicable_components_length;
comp_image_set_version_str->ptr =
applicable_components->ptr + applicable_components->length;
comp_image_set_version_str->length =
fw_device_id_record->comp_image_set_version_string_length;
record_descriptors->ptr = comp_image_set_version_str->ptr +
comp_image_set_version_str->length;
record_descriptors->length =
fw_device_id_record->record_length -
sizeof(struct pldm_firmware_device_id_record) -
applicable_components_length -
fw_device_id_record->comp_image_set_version_string_length -
fw_device_id_record->fw_device_pkg_data_length;
if (fw_device_id_record->fw_device_pkg_data_length) {
fw_device_pkg_data->ptr =
record_descriptors->ptr + record_descriptors->length;
fw_device_pkg_data->length =
fw_device_id_record->fw_device_pkg_data_length;
}
return PLDM_SUCCESS;
}
int decode_descriptor_type_length_value(const uint8_t *data, size_t length,
uint16_t *descriptor_type,
struct variable_field *descriptor_data)
{
uint16_t descriptor_length = 0;
if (data == NULL || descriptor_type == NULL ||
descriptor_data == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (length < PLDM_FWUP_DEVICE_DESCRIPTOR_MIN_LEN) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_descriptor_tlv *entry =
(struct pldm_descriptor_tlv *)(data);
*descriptor_type = le16toh(entry->descriptor_type);
descriptor_length = le16toh(entry->descriptor_length);
if (*descriptor_type != PLDM_FWUP_VENDOR_DEFINED) {
if (descriptor_length !=
get_descriptor_type_length(*descriptor_type)) {
return PLDM_ERROR_INVALID_LENGTH;
}
}
if (length < (sizeof(*descriptor_type) + sizeof(descriptor_length) +
descriptor_length)) {
return PLDM_ERROR_INVALID_LENGTH;
}
descriptor_data->ptr = entry->descriptor_data;
descriptor_data->length = descriptor_length;
return PLDM_SUCCESS;
}
int decode_vendor_defined_descriptor_value(
const uint8_t *data, size_t length, uint8_t *descriptor_title_str_type,
struct variable_field *descriptor_title_str,
struct variable_field *descriptor_data)
{
if (data == NULL || descriptor_title_str_type == NULL ||
descriptor_title_str == NULL || descriptor_data == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (length < sizeof(struct pldm_vendor_defined_descriptor_title_data)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_vendor_defined_descriptor_title_data *entry =
(struct pldm_vendor_defined_descriptor_title_data *)(data);
if (!is_string_type_valid(
entry->vendor_defined_descriptor_title_str_type) ||
(entry->vendor_defined_descriptor_title_str_len == 0)) {
return PLDM_ERROR_INVALID_DATA;
}
// Assuming atleast 1 byte of VendorDefinedDescriptorData
if (length < (sizeof(struct pldm_vendor_defined_descriptor_title_data) +
entry->vendor_defined_descriptor_title_str_len)) {
return PLDM_ERROR_INVALID_LENGTH;
}
*descriptor_title_str_type =
entry->vendor_defined_descriptor_title_str_type;
descriptor_title_str->ptr = entry->vendor_defined_descriptor_title_str;
descriptor_title_str->length =
entry->vendor_defined_descriptor_title_str_len;
descriptor_data->ptr =
descriptor_title_str->ptr + descriptor_title_str->length;
descriptor_data->length =
length -
sizeof(entry->vendor_defined_descriptor_title_str_type) -
sizeof(entry->vendor_defined_descriptor_title_str_len) -
descriptor_title_str->length;
return PLDM_SUCCESS;
}
int decode_pldm_comp_image_info(
const uint8_t *data, size_t length,
struct pldm_component_image_information *pldm_comp_image_info,
struct variable_field *comp_version_str)
{
if (data == NULL || pldm_comp_image_info == NULL ||
comp_version_str == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (length < sizeof(struct pldm_component_image_information)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_component_image_information *data_header =
(struct pldm_component_image_information *)(data);
if (!is_string_type_valid(data_header->comp_version_string_type) ||
(data_header->comp_version_string_length == 0)) {
return PLDM_ERROR_INVALID_DATA;
}
if (length < sizeof(struct pldm_component_image_information) +
data_header->comp_version_string_length) {
return PLDM_ERROR_INVALID_LENGTH;
}
pldm_comp_image_info->comp_classification =
le16toh(data_header->comp_classification);
pldm_comp_image_info->comp_identifier =
le16toh(data_header->comp_identifier);
pldm_comp_image_info->comp_comparison_stamp =
le32toh(data_header->comp_comparison_stamp);
pldm_comp_image_info->comp_options.value =
le16toh(data_header->comp_options.value);
pldm_comp_image_info->requested_comp_activation_method.value =
le16toh(data_header->requested_comp_activation_method.value);
pldm_comp_image_info->comp_location_offset =
le32toh(data_header->comp_location_offset);
pldm_comp_image_info->comp_size = le32toh(data_header->comp_size);
pldm_comp_image_info->comp_version_string_type =
data_header->comp_version_string_type;
pldm_comp_image_info->comp_version_string_length =
data_header->comp_version_string_length;
if ((pldm_comp_image_info->comp_options.bits.bit1 == false &&
pldm_comp_image_info->comp_comparison_stamp !=
PLDM_FWUP_INVALID_COMPONENT_COMPARISON_TIMESTAMP)) {
return PLDM_ERROR_INVALID_DATA;
}
if (pldm_comp_image_info->comp_location_offset == 0 ||
pldm_comp_image_info->comp_size == 0) {
return PLDM_ERROR_INVALID_DATA;
}
comp_version_str->ptr =
data + sizeof(struct pldm_component_image_information);
comp_version_str->length =
pldm_comp_image_info->comp_version_string_length;
return PLDM_SUCCESS;
}
int encode_query_device_identifiers_req(uint8_t instance_id,
size_t payload_length,
struct pldm_msg *msg)
{
if (msg == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != PLDM_QUERY_DEVICE_IDENTIFIERS_REQ_BYTES) {
return PLDM_ERROR_INVALID_LENGTH;
}
return encode_pldm_header_only(PLDM_REQUEST, instance_id, PLDM_FWUP,
PLDM_QUERY_DEVICE_IDENTIFIERS, msg);
}
int decode_query_device_identifiers_resp(const struct pldm_msg *msg,
size_t payload_length,
uint8_t *completion_code,
uint32_t *device_identifiers_len,
uint8_t *descriptor_count,
uint8_t **descriptor_data)
{
if (msg == NULL || completion_code == NULL ||
device_identifiers_len == NULL || descriptor_count == NULL ||
descriptor_data == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
*completion_code = msg->payload[0];
if (PLDM_SUCCESS != *completion_code) {
return PLDM_SUCCESS;
}
if (payload_length <
sizeof(struct pldm_query_device_identifiers_resp)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_query_device_identifiers_resp *response =
(struct pldm_query_device_identifiers_resp *)msg->payload;
*device_identifiers_len = le32toh(response->device_identifiers_len);
if (*device_identifiers_len < PLDM_FWUP_DEVICE_DESCRIPTOR_MIN_LEN) {
return PLDM_ERROR_INVALID_LENGTH;
}
if (payload_length !=
sizeof(struct pldm_query_device_identifiers_resp) +
*device_identifiers_len) {
return PLDM_ERROR_INVALID_LENGTH;
}
*descriptor_count = response->descriptor_count;
if (*descriptor_count == 0) {
return PLDM_ERROR_INVALID_DATA;
}
*descriptor_data =
(uint8_t *)(msg->payload +
sizeof(struct pldm_query_device_identifiers_resp));
return PLDM_SUCCESS;
}
int encode_get_firmware_parameters_req(uint8_t instance_id,
size_t payload_length,
struct pldm_msg *msg)
{
if (msg == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != PLDM_GET_FIRMWARE_PARAMETERS_REQ_BYTES) {
return PLDM_ERROR_INVALID_LENGTH;
}
return encode_pldm_header_only(PLDM_REQUEST, instance_id, PLDM_FWUP,
PLDM_GET_FIRMWARE_PARAMETERS, msg);
}
int decode_get_firmware_parameters_resp(
const struct pldm_msg *msg, size_t payload_length,
struct pldm_get_firmware_parameters_resp *resp_data,
struct variable_field *active_comp_image_set_ver_str,
struct variable_field *pending_comp_image_set_ver_str,
struct variable_field *comp_parameter_table)
{
if (msg == NULL || resp_data == NULL ||
active_comp_image_set_ver_str == NULL ||
pending_comp_image_set_ver_str == NULL ||
comp_parameter_table == NULL || !payload_length) {
return PLDM_ERROR_INVALID_DATA;
}
resp_data->completion_code = msg->payload[0];
if (PLDM_SUCCESS != resp_data->completion_code) {
return PLDM_SUCCESS;
}
if (payload_length < sizeof(struct pldm_get_firmware_parameters_resp)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_get_firmware_parameters_resp *response =
(struct pldm_get_firmware_parameters_resp *)msg->payload;
if (!is_string_type_valid(
response->active_comp_image_set_ver_str_type) ||
(response->active_comp_image_set_ver_str_len == 0)) {
return PLDM_ERROR_INVALID_DATA;
}
if (response->pending_comp_image_set_ver_str_len == 0) {
if (response->pending_comp_image_set_ver_str_type !=
PLDM_STR_TYPE_UNKNOWN) {
return PLDM_ERROR_INVALID_DATA;
}
} else {
if (!is_string_type_valid(
response->pending_comp_image_set_ver_str_type)) {
return PLDM_ERROR_INVALID_DATA;
}
}
size_t partial_response_length =
sizeof(struct pldm_get_firmware_parameters_resp) +
response->active_comp_image_set_ver_str_len +
response->pending_comp_image_set_ver_str_len;
if (payload_length < partial_response_length) {
return PLDM_ERROR_INVALID_LENGTH;
}
resp_data->capabilities_during_update.value =
le32toh(response->capabilities_during_update.value);
resp_data->comp_count = le16toh(response->comp_count);
resp_data->active_comp_image_set_ver_str_type =
response->active_comp_image_set_ver_str_type;
resp_data->active_comp_image_set_ver_str_len =
response->active_comp_image_set_ver_str_len;
resp_data->pending_comp_image_set_ver_str_type =
response->pending_comp_image_set_ver_str_type;
resp_data->pending_comp_image_set_ver_str_len =
response->pending_comp_image_set_ver_str_len;
active_comp_image_set_ver_str->ptr =
msg->payload + sizeof(struct pldm_get_firmware_parameters_resp);
active_comp_image_set_ver_str->length =
resp_data->active_comp_image_set_ver_str_len;
if (resp_data->pending_comp_image_set_ver_str_len != 0) {
pending_comp_image_set_ver_str->ptr =
msg->payload +
sizeof(struct pldm_get_firmware_parameters_resp) +
resp_data->active_comp_image_set_ver_str_len;
pending_comp_image_set_ver_str->length =
resp_data->pending_comp_image_set_ver_str_len;
} else {
pending_comp_image_set_ver_str->ptr = NULL;
pending_comp_image_set_ver_str->length = 0;
}
if (payload_length > partial_response_length && resp_data->comp_count) {
comp_parameter_table->ptr =
msg->payload +
sizeof(struct pldm_get_firmware_parameters_resp) +
resp_data->active_comp_image_set_ver_str_len +
resp_data->pending_comp_image_set_ver_str_len;
comp_parameter_table->length =
payload_length - partial_response_length;
} else {
comp_parameter_table->ptr = NULL;
comp_parameter_table->length = 0;
}
return PLDM_SUCCESS;
}
int decode_get_firmware_parameters_resp_comp_entry(
const uint8_t *data, size_t length,
struct pldm_component_parameter_entry *component_data,
struct variable_field *active_comp_ver_str,
struct variable_field *pending_comp_ver_str)
{
if (data == NULL || component_data == NULL ||
active_comp_ver_str == NULL || pending_comp_ver_str == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (length < sizeof(struct pldm_component_parameter_entry)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_component_parameter_entry *entry =
(struct pldm_component_parameter_entry *)(data);
size_t entry_length = sizeof(struct pldm_component_parameter_entry) +
entry->active_comp_ver_str_len +
entry->pending_comp_ver_str_len;
if (length < entry_length) {
return PLDM_ERROR_INVALID_LENGTH;
}
component_data->comp_classification =
le16toh(entry->comp_classification);
component_data->comp_identifier = le16toh(entry->comp_identifier);
component_data->comp_classification_index =
entry->comp_classification_index;
component_data->active_comp_comparison_stamp =
le32toh(entry->active_comp_comparison_stamp);
component_data->active_comp_ver_str_type =
entry->active_comp_ver_str_type;
component_data->active_comp_ver_str_len =
entry->active_comp_ver_str_len;
memcpy(component_data->active_comp_release_date,
entry->active_comp_release_date,
sizeof(entry->active_comp_release_date));
component_data->pending_comp_comparison_stamp =
le32toh(entry->pending_comp_comparison_stamp);
component_data->pending_comp_ver_str_type =
entry->pending_comp_ver_str_type;
component_data->pending_comp_ver_str_len =
entry->pending_comp_ver_str_len;
memcpy(component_data->pending_comp_release_date,
entry->pending_comp_release_date,
sizeof(entry->pending_comp_release_date));
component_data->comp_activation_methods.value =
le16toh(entry->comp_activation_methods.value);
component_data->capabilities_during_update.value =
le32toh(entry->capabilities_during_update.value);
if (entry->active_comp_ver_str_len != 0) {
active_comp_ver_str->ptr =
data + sizeof(struct pldm_component_parameter_entry);
active_comp_ver_str->length = entry->active_comp_ver_str_len;
} else {
active_comp_ver_str->ptr = NULL;
active_comp_ver_str->length = 0;
}
if (entry->pending_comp_ver_str_len != 0) {
pending_comp_ver_str->ptr =
data + sizeof(struct pldm_component_parameter_entry) +
entry->active_comp_ver_str_len;
pending_comp_ver_str->length = entry->pending_comp_ver_str_len;
} else {
pending_comp_ver_str->ptr = NULL;
pending_comp_ver_str->length = 0;
}
return PLDM_SUCCESS;
}
int encode_request_update_req(uint8_t instance_id, uint32_t max_transfer_size,
uint16_t num_of_comp,
uint8_t max_outstanding_transfer_req,
uint16_t pkg_data_len,
uint8_t comp_image_set_ver_str_type,
uint8_t comp_image_set_ver_str_len,
const struct variable_field *comp_img_set_ver_str,
struct pldm_msg *msg, size_t payload_length)
{
if (comp_img_set_ver_str == NULL || comp_img_set_ver_str->ptr == NULL ||
msg == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != sizeof(struct pldm_request_update_req) +
comp_img_set_ver_str->length) {
return PLDM_ERROR_INVALID_LENGTH;
}
if ((comp_image_set_ver_str_len == 0) ||
(comp_image_set_ver_str_len != comp_img_set_ver_str->length)) {
return PLDM_ERROR_INVALID_DATA;
}
if ((max_transfer_size < PLDM_FWUP_BASELINE_TRANSFER_SIZE) ||
(max_outstanding_transfer_req < PLDM_FWUP_MIN_OUTSTANDING_REQ)) {
return PLDM_ERROR_INVALID_DATA;
}
if (!is_string_type_valid(comp_image_set_ver_str_type)) {
return PLDM_ERROR_INVALID_DATA;
}
struct pldm_header_info header = { 0 };
header.instance = instance_id;
header.msg_type = PLDM_REQUEST;
header.pldm_type = PLDM_FWUP;
header.command = PLDM_REQUEST_UPDATE;
uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
if (rc) {
return rc;
}
struct pldm_request_update_req *request =
(struct pldm_request_update_req *)msg->payload;
request->max_transfer_size = htole32(max_transfer_size);
request->num_of_comp = htole16(num_of_comp);
request->max_outstanding_transfer_req = max_outstanding_transfer_req;
request->pkg_data_len = htole16(pkg_data_len);
request->comp_image_set_ver_str_type = comp_image_set_ver_str_type;
request->comp_image_set_ver_str_len = comp_image_set_ver_str_len;
memcpy(msg->payload + sizeof(struct pldm_request_update_req),
comp_img_set_ver_str->ptr, comp_img_set_ver_str->length);
return PLDM_SUCCESS;
}
int decode_request_update_resp(const struct pldm_msg *msg,
size_t payload_length, uint8_t *completion_code,
uint16_t *fd_meta_data_len,
uint8_t *fd_will_send_pkg_data)
{
if (msg == NULL || completion_code == NULL ||
fd_meta_data_len == NULL || fd_will_send_pkg_data == NULL ||
!payload_length) {
return PLDM_ERROR_INVALID_DATA;
}
*completion_code = msg->payload[0];
if (*completion_code != PLDM_SUCCESS) {
return PLDM_SUCCESS;
}
if (payload_length != sizeof(struct pldm_request_update_resp)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_request_update_resp *response =
(struct pldm_request_update_resp *)msg->payload;
*fd_meta_data_len = le16toh(response->fd_meta_data_len);
*fd_will_send_pkg_data = response->fd_will_send_pkg_data;
return PLDM_SUCCESS;
}
int encode_pass_component_table_req(uint8_t instance_id, uint8_t transfer_flag,
uint16_t comp_classification,
uint16_t comp_identifier,
uint8_t comp_classification_index,
uint32_t comp_comparison_stamp,
uint8_t comp_ver_str_type,
uint8_t comp_ver_str_len,
const struct variable_field *comp_ver_str,
struct pldm_msg *msg, size_t payload_length)
{
if (comp_ver_str == NULL || comp_ver_str->ptr == NULL || msg == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != sizeof(struct pldm_pass_component_table_req) +
comp_ver_str->length) {
return PLDM_ERROR_INVALID_LENGTH;
}
if ((comp_ver_str_len == 0) ||
(comp_ver_str_len != comp_ver_str->length)) {
return PLDM_ERROR_INVALID_DATA;
}
if (!is_transfer_flag_valid(transfer_flag)) {
return PLDM_INVALID_TRANSFER_OPERATION_FLAG;
}
if (!is_string_type_valid(comp_ver_str_type)) {
return PLDM_ERROR_INVALID_DATA;
}
struct pldm_header_info header = { 0 };
header.instance = instance_id;
header.msg_type = PLDM_REQUEST;
header.pldm_type = PLDM_FWUP;
header.command = PLDM_PASS_COMPONENT_TABLE;
uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
if (rc) {
return rc;
}
struct pldm_pass_component_table_req *request =
(struct pldm_pass_component_table_req *)msg->payload;
request->transfer_flag = transfer_flag;
request->comp_classification = htole16(comp_classification);
request->comp_identifier = htole16(comp_identifier);
request->comp_classification_index = comp_classification_index;
request->comp_comparison_stamp = htole32(comp_comparison_stamp);
request->comp_ver_str_type = comp_ver_str_type;
request->comp_ver_str_len = comp_ver_str_len;
memcpy(msg->payload + sizeof(struct pldm_pass_component_table_req),
comp_ver_str->ptr, comp_ver_str->length);
return PLDM_SUCCESS;
}
int decode_pass_component_table_resp(const struct pldm_msg *msg,
const size_t payload_length,
uint8_t *completion_code,
uint8_t *comp_resp,
uint8_t *comp_resp_code)
{
if (msg == NULL || completion_code == NULL || comp_resp == NULL ||
comp_resp_code == NULL || !payload_length) {
return PLDM_ERROR_INVALID_DATA;
}
*completion_code = msg->payload[0];
if (*completion_code != PLDM_SUCCESS) {
return PLDM_SUCCESS;
}
if (payload_length != sizeof(struct pldm_pass_component_table_resp)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_pass_component_table_resp *response =
(struct pldm_pass_component_table_resp *)msg->payload;
if (!is_comp_resp_valid(response->comp_resp)) {
return PLDM_ERROR_INVALID_DATA;
}
if (!is_comp_resp_code_valid(response->comp_resp_code)) {
return PLDM_ERROR_INVALID_DATA;
}
*comp_resp = response->comp_resp;
*comp_resp_code = response->comp_resp_code;
return PLDM_SUCCESS;
}
int encode_update_component_req(
uint8_t instance_id, uint16_t comp_classification,
uint16_t comp_identifier, uint8_t comp_classification_index,
uint32_t comp_comparison_stamp, uint32_t comp_image_size,
bitfield32_t update_option_flags, uint8_t comp_ver_str_type,
uint8_t comp_ver_str_len, const struct variable_field *comp_ver_str,
struct pldm_msg *msg, size_t payload_length)
{
if (comp_ver_str == NULL || comp_ver_str->ptr == NULL || msg == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length !=
sizeof(struct pldm_update_component_req) + comp_ver_str->length) {
return PLDM_ERROR_INVALID_LENGTH;
}
if (!comp_image_size) {
return PLDM_ERROR_INVALID_DATA;
}
if ((comp_ver_str_len == 0) ||
(comp_ver_str_len != comp_ver_str->length)) {
return PLDM_ERROR_INVALID_DATA;
}
if (!is_string_type_valid(comp_ver_str_type)) {
return PLDM_ERROR_INVALID_DATA;
}
struct pldm_header_info header = { 0 };
header.instance = instance_id;
header.msg_type = PLDM_REQUEST;
header.pldm_type = PLDM_FWUP;
header.command = PLDM_UPDATE_COMPONENT;
uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
if (rc) {
return rc;
}
struct pldm_update_component_req *request =
(struct pldm_update_component_req *)msg->payload;
request->comp_classification = htole16(comp_classification);
request->comp_identifier = htole16(comp_identifier);
request->comp_classification_index = comp_classification_index;
request->comp_comparison_stamp = htole32(comp_comparison_stamp);
request->comp_image_size = htole32(comp_image_size);
request->update_option_flags.value = htole32(update_option_flags.value);
request->comp_ver_str_type = comp_ver_str_type;
request->comp_ver_str_len = comp_ver_str_len;
memcpy(msg->payload + sizeof(struct pldm_update_component_req),
comp_ver_str->ptr, comp_ver_str->length);
return PLDM_SUCCESS;
}
int decode_update_component_resp(const struct pldm_msg *msg,
size_t payload_length,
uint8_t *completion_code,
uint8_t *comp_compatibility_resp,
uint8_t *comp_compatibility_resp_code,
bitfield32_t *update_option_flags_enabled,
uint16_t *time_before_req_fw_data)
{
if (msg == NULL || completion_code == NULL ||
comp_compatibility_resp == NULL ||
comp_compatibility_resp_code == NULL ||
update_option_flags_enabled == NULL ||
time_before_req_fw_data == NULL || !payload_length) {
return PLDM_ERROR_INVALID_DATA;
}
*completion_code = msg->payload[0];
if (*completion_code != PLDM_SUCCESS) {
return PLDM_SUCCESS;
}
if (payload_length != sizeof(struct pldm_update_component_resp)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_update_component_resp *response =
(struct pldm_update_component_resp *)msg->payload;
if (!is_comp_compatibility_resp_valid(
response->comp_compatibility_resp)) {
return PLDM_ERROR_INVALID_DATA;
}
if (!is_comp_compatibility_resp_code_valid(
response->comp_compatibility_resp_code)) {
return PLDM_ERROR_INVALID_DATA;
}
*comp_compatibility_resp = response->comp_compatibility_resp;
*comp_compatibility_resp_code = response->comp_compatibility_resp_code;
update_option_flags_enabled->value =
le32toh(response->update_option_flags_enabled.value);
*time_before_req_fw_data = le16toh(response->time_before_req_fw_data);
return PLDM_SUCCESS;
}
int decode_request_firmware_data_req(const struct pldm_msg *msg,
size_t payload_length, uint32_t *offset,
uint32_t *length)
{
if (msg == NULL || offset == NULL || length == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != sizeof(struct pldm_request_firmware_data_req)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_request_firmware_data_req *request =
(struct pldm_request_firmware_data_req *)msg->payload;
*offset = le32toh(request->offset);
*length = le32toh(request->length);
if (*length < PLDM_FWUP_BASELINE_TRANSFER_SIZE) {
return PLDM_FWUP_INVALID_TRANSFER_LENGTH;
}
return PLDM_SUCCESS;
}
int encode_request_firmware_data_resp(uint8_t instance_id,
uint8_t completion_code,
struct pldm_msg *msg,
size_t payload_length)
{
if (msg == NULL || !payload_length) {
return PLDM_ERROR_INVALID_DATA;
}
struct pldm_header_info header = { 0 };
header.instance = instance_id;
header.msg_type = PLDM_RESPONSE;
header.pldm_type = PLDM_FWUP;
header.command = PLDM_REQUEST_FIRMWARE_DATA;
uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
if (rc) {
return rc;
}
msg->payload[0] = completion_code;
return PLDM_SUCCESS;
}
int decode_transfer_complete_req(const struct pldm_msg *msg,
size_t payload_length,
uint8_t *transfer_result)
{
if (msg == NULL || transfer_result == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != sizeof(*transfer_result)) {
return PLDM_ERROR_INVALID_LENGTH;
}
*transfer_result = msg->payload[0];
return PLDM_SUCCESS;
}
int encode_transfer_complete_resp(uint8_t instance_id, uint8_t completion_code,
struct pldm_msg *msg, size_t payload_length)
{
if (msg == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != sizeof(completion_code)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_header_info header = { 0 };
header.instance = instance_id;
header.msg_type = PLDM_RESPONSE;
header.pldm_type = PLDM_FWUP;
header.command = PLDM_TRANSFER_COMPLETE;
uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
if (rc) {
return rc;
}
msg->payload[0] = completion_code;
return PLDM_SUCCESS;
}
int decode_verify_complete_req(const struct pldm_msg *msg,
size_t payload_length, uint8_t *verify_result)
{
if (msg == NULL || verify_result == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != sizeof(*verify_result)) {
return PLDM_ERROR_INVALID_LENGTH;
}
*verify_result = msg->payload[0];
return PLDM_SUCCESS;
}
int encode_verify_complete_resp(uint8_t instance_id, uint8_t completion_code,
struct pldm_msg *msg, size_t payload_length)
{
if (msg == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != sizeof(completion_code)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_header_info header = { 0 };
header.instance = instance_id;
header.msg_type = PLDM_RESPONSE;
header.pldm_type = PLDM_FWUP;
header.command = PLDM_VERIFY_COMPLETE;
uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
if (rc) {
return rc;
}
msg->payload[0] = completion_code;
return PLDM_SUCCESS;
}
int decode_apply_complete_req(const struct pldm_msg *msg, size_t payload_length,
uint8_t *apply_result,
bitfield16_t *comp_activation_methods_modification)
{
if (msg == NULL || apply_result == NULL ||
comp_activation_methods_modification == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != sizeof(struct pldm_apply_complete_req)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_apply_complete_req *request =
(struct pldm_apply_complete_req *)msg->payload;
*apply_result = request->apply_result;
comp_activation_methods_modification->value =
le16toh(request->comp_activation_methods_modification.value);
if ((*apply_result != PLDM_FWUP_APPLY_SUCCESS_WITH_ACTIVATION_METHOD) &&
comp_activation_methods_modification->value) {
return PLDM_ERROR_INVALID_DATA;
}
return PLDM_SUCCESS;
}
int encode_apply_complete_resp(uint8_t instance_id, uint8_t completion_code,
struct pldm_msg *msg, size_t payload_length)
{
if (msg == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != sizeof(completion_code)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_header_info header = { 0 };
header.instance = instance_id;
header.msg_type = PLDM_RESPONSE;
header.pldm_type = PLDM_FWUP;
header.command = PLDM_APPLY_COMPLETE;
uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
if (rc) {
return rc;
}
msg->payload[0] = completion_code;
return PLDM_SUCCESS;
}
int encode_activate_firmware_req(uint8_t instance_id,
bool8_t self_contained_activation_req,
struct pldm_msg *msg, size_t payload_length)
{
if (msg == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != sizeof(struct pldm_activate_firmware_req)) {
return PLDM_ERROR_INVALID_LENGTH;
}
if (!is_self_contained_activation_req_valid(
self_contained_activation_req)) {
return PLDM_ERROR_INVALID_DATA;
}
struct pldm_header_info header = { 0 };
header.instance = instance_id;
header.msg_type = PLDM_REQUEST;
header.pldm_type = PLDM_FWUP;
header.command = PLDM_ACTIVATE_FIRMWARE;
uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
if (rc) {
return rc;
}
struct pldm_activate_firmware_req *request =
(struct pldm_activate_firmware_req *)msg->payload;
request->self_contained_activation_req = self_contained_activation_req;
return PLDM_SUCCESS;
}
int decode_activate_firmware_resp(const struct pldm_msg *msg,
size_t payload_length,
uint8_t *completion_code,
uint16_t *estimated_time_activation)
{
if (msg == NULL || completion_code == NULL ||
estimated_time_activation == NULL || !payload_length) {
return PLDM_ERROR_INVALID_DATA;
}
*completion_code = msg->payload[0];
if (*completion_code != PLDM_SUCCESS) {
return PLDM_SUCCESS;
}
if (payload_length != sizeof(struct pldm_activate_firmware_resp)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_activate_firmware_resp *response =
(struct pldm_activate_firmware_resp *)msg->payload;
*estimated_time_activation =
le16toh(response->estimated_time_activation);
return PLDM_SUCCESS;
}
int encode_get_status_req(uint8_t instance_id, struct pldm_msg *msg,
size_t payload_length)
{
if (msg == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != PLDM_GET_STATUS_REQ_BYTES) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_header_info header = { 0 };
header.instance = instance_id;
header.msg_type = PLDM_REQUEST;
header.pldm_type = PLDM_FWUP;
header.command = PLDM_GET_STATUS;
uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
if (rc) {
return rc;
}
return PLDM_SUCCESS;
}
int decode_get_status_resp(const struct pldm_msg *msg, size_t payload_length,
uint8_t *completion_code, uint8_t *current_state,
uint8_t *previous_state, uint8_t *aux_state,
uint8_t *aux_state_status, uint8_t *progress_percent,
uint8_t *reason_code,
bitfield32_t *update_option_flags_enabled)
{
if (msg == NULL || completion_code == NULL || current_state == NULL ||
previous_state == NULL || aux_state == NULL ||
aux_state_status == NULL || progress_percent == NULL ||
reason_code == NULL || update_option_flags_enabled == NULL ||
!payload_length) {
return PLDM_ERROR_INVALID_DATA;
}
*completion_code = msg->payload[0];
if (*completion_code != PLDM_SUCCESS) {
return PLDM_SUCCESS;
}
if (payload_length != sizeof(struct pldm_get_status_resp)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_get_status_resp *response =
(struct pldm_get_status_resp *)msg->payload;
if (!is_state_valid(response->current_state)) {
return PLDM_ERROR_INVALID_DATA;
}
if (!is_state_valid(response->previous_state)) {
return PLDM_ERROR_INVALID_DATA;
}
if (!is_aux_state_valid(response->aux_state)) {
return PLDM_ERROR_INVALID_DATA;
}
if (!is_aux_state_status_valid(response->aux_state_status)) {
return PLDM_ERROR_INVALID_DATA;
}
if (response->progress_percent > PLDM_FWUP_MAX_PROGRESS_PERCENT) {
return PLDM_ERROR_INVALID_DATA;
}
if (!is_reason_code_valid(response->reason_code)) {
return PLDM_ERROR_INVALID_DATA;
}
if ((response->current_state == PLDM_FD_STATE_IDLE) ||
(response->current_state == PLDM_FD_STATE_LEARN_COMPONENTS) ||
(response->current_state == PLDM_FD_STATE_READY_XFER)) {
if (response->aux_state !=
PLDM_FD_IDLE_LEARN_COMPONENTS_READ_XFER) {
return PLDM_ERROR_INVALID_DATA;
}
}
*current_state = response->current_state;
*previous_state = response->previous_state;
*aux_state = response->aux_state;
*aux_state_status = response->aux_state_status;
*progress_percent = response->progress_percent;
*reason_code = response->reason_code;
update_option_flags_enabled->value =
le32toh(response->update_option_flags_enabled.value);
return PLDM_SUCCESS;
}
int encode_cancel_update_component_req(uint8_t instance_id,
struct pldm_msg *msg,
size_t payload_length)
{
if (msg == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != PLDM_CANCEL_UPDATE_COMPONENT_REQ_BYTES) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_header_info header = { 0 };
header.instance = instance_id;
header.msg_type = PLDM_REQUEST;
header.pldm_type = PLDM_FWUP;
header.command = PLDM_CANCEL_UPDATE_COMPONENT;
uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
if (rc) {
return rc;
}
return PLDM_SUCCESS;
}
int decode_cancel_update_component_resp(const struct pldm_msg *msg,
size_t payload_length,
uint8_t *completion_code)
{
if (msg == NULL || completion_code == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != sizeof(*completion_code)) {
return PLDM_ERROR_INVALID_LENGTH;
}
*completion_code = msg->payload[0];
return PLDM_SUCCESS;
}
int encode_cancel_update_req(uint8_t instance_id, struct pldm_msg *msg,
size_t payload_length)
{
if (msg == NULL) {
return PLDM_ERROR_INVALID_DATA;
}
if (payload_length != PLDM_CANCEL_UPDATE_REQ_BYTES) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_header_info header = { 0 };
header.instance = instance_id;
header.msg_type = PLDM_REQUEST;
header.pldm_type = PLDM_FWUP;
header.command = PLDM_CANCEL_UPDATE;
uint8_t rc = pack_pldm_header(&header, &(msg->hdr));
if (rc) {
return rc;
}
return PLDM_SUCCESS;
}
int decode_cancel_update_resp(const struct pldm_msg *msg, size_t payload_length,
uint8_t *completion_code,
bool8_t *non_functioning_component_indication,
bitfield64_t *non_functioning_component_bitmap)
{
if (msg == NULL || completion_code == NULL ||
non_functioning_component_indication == NULL ||
non_functioning_component_bitmap == NULL || !payload_length) {
return PLDM_ERROR_INVALID_DATA;
}
*completion_code = msg->payload[0];
if (*completion_code != PLDM_SUCCESS) {
return PLDM_SUCCESS;
}
if (payload_length != sizeof(struct pldm_cancel_update_resp)) {
return PLDM_ERROR_INVALID_LENGTH;
}
struct pldm_cancel_update_resp *response =
(struct pldm_cancel_update_resp *)msg->payload;
if (!is_non_functioning_component_indication_valid(
response->non_functioning_component_indication)) {
return PLDM_ERROR_INVALID_DATA;
}
*non_functioning_component_indication =
response->non_functioning_component_indication;
if (*non_functioning_component_indication) {
non_functioning_component_bitmap->value =
le64toh(response->non_functioning_component_bitmap);
}
return PLDM_SUCCESS;
}
|