firmware_update: Add DSP0267 v1.3.0 version updates
- Added `reference_manifest_data` and `payload_checksum` fields
to relevant data structures.
- Implemented decode functionality for these fields to correctly
parse their contents.
- Added unit tests for DSP0267 v1.3.0 to verify the new
decoding functionality.
Change-Id: I4403ab18daffcec5a51247a8ba6cd426072dd764
Signed-off-by: Carter Chen <carter.chen.wiwynn@gmail.com>
diff --git a/tests/dsp/firmware_update.cpp b/tests/dsp/firmware_update.cpp
index 4e16552..21b65ca 100644
--- a/tests/dsp/firmware_update.cpp
+++ b/tests/dsp/firmware_update.cpp
@@ -60,6 +60,11 @@
0x4a, 0x99, 0xaf, 0x6d, 0x46, 0xf8,
0xb1, 0x21, 0xf6, 0xbf};
+static constexpr std::array<uint8_t, PLDM_FWUP_UUID_LENGTH>
+ PLDM_FWUP_PACKAGE_HEADER_IDENTIFIER_V1_3{0x7b, 0x29, 0x1c, 0x99, 0x6d, 0xb6,
+ 0x42, 0x08, 0x80, 0x1B, 0x02, 0x02,
+ 0x6E, 0x46, 0x3C, 0x78};
+
static constexpr size_t PLDM_FWUP_PACKAGE_HEADER_EMPTY_SIZE_V1_0 = 43;
static constexpr std::array<uint8_t, PLDM_TIMESTAMP104_SIZE>
@@ -5653,4 +5658,254 @@
EXPECT_EQ(nr_infos, 2);
}
+#endif
+
+#ifdef LIBPLDM_API_TESTING
+TEST(DecodePldmFirmwareUpdatePackage, v4h1fd1fdd1dd1ddd2cii)
+{
+ const std::array<uint8_t, 182> package{
+ 0x7B, 0x29, 0x1C, 0x99, 0x6D, 0xB6, 0x42, 0x08, 0x80, 0x1B, 0x02, 0x02,
+ 0x6E, 0x46, 0x3C, 0x78, 0x04, 0xB4, 0x00, 0x00, 0xe9, 0x07, 0x03, 0x0b,
+ 0x16, 0x03, 0x00, 0x00, 0x00, 0x00, 0x76, 0x02, 0x08, 0x00, 0x01, 0x04,
+ 't', 'e', 's', 't',
+
+ 0x01, 0x1E, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x01, 0x04, 0x00, 0x00,
+ 0x02, 0x00, 0x00, 0x00, 0x01, 'v', '0', '.', '1', 0x01, 0x00, 0x04,
+ 0x00, 0x9c, 0x01, 0x00, 0x00, 0x87, 0x65,
+
+ 0x01, 0x1E, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x01, 0x04, 0x00, 0x00,
+ 0x02, 0x00, 0x00, 0x00, 0x02, 'v', '1', '.', '0', 0x01, 0x00, 0x04,
+ 0x00, 0x9c, 0x01, 0x00, 0x00, 0x87, 0x65,
+
+ 0x02, 0x00,
+
+ 0x0a, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x01, 0x00,
+ 0xB4, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x04, 'v', '0',
+ '.', '2', 0x04, 0x00, 0x00, 0x00, 0x12, 0x34, 0x56, 0x78,
+
+ 0x0a, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x01, 0x00,
+ 0xB5, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x04, 'v', '2',
+ '.', '0', 0x04, 0x00, 0x00, 0x00, 0x12, 0x34, 0x56, 0x78,
+
+ 0xf7, 0xf7, 0xfd, 0x79,
+
+ 0x46, 0xf0, 0x31, 0xa7,
+
+ 0x5a,
+
+ 0xa5,
+
+ };
+
+ struct pldm_package_downstream_device_id_record ddrec;
+ struct pldm_package_component_image_information info;
+ struct pldm_package_firmware_device_id_record fdrec;
+ DEFINE_PLDM_PACKAGE_FORMAT_PIN_FR04H(pin);
+ pldm_package_header_information_pad hdr;
+ struct pldm_package_iter iter;
+ int nr_fdrec_desc = 0;
+ int nr_ddrec_desc = 0;
+ int nr_fdrec = 0;
+ int nr_ddrec = 0;
+ int nr_infos = 0;
+ int rc;
+
+ rc = decode_pldm_firmware_update_package(package.data(), package.size(),
+ &pin, &hdr, &iter);
+ ASSERT_EQ(rc, 0);
+
+ EXPECT_EQ(memcmp(PLDM_FWUP_PACKAGE_HEADER_IDENTIFIER_V1_3.data(),
+ hdr.package_header_identifier,
+ PLDM_FWUP_PACKAGE_HEADER_IDENTIFIER_V1_3.size()),
+ 0);
+ EXPECT_EQ(hdr.package_header_format_revision, 4);
+
+ static const std::array<uint8_t, 13> timestamp{0x00, 0xe9, 0x07, 0x03, 0x0b,
+ 0x16, 0x03, 0x00, 0x00, 0x00,
+ 0x00, 0x76, 0x02};
+ ASSERT_EQ(timestamp.size(), sizeof(hdr.package_release_date_time));
+ EXPECT_EQ(memcmp(timestamp.data(), hdr.package_release_date_time,
+ timestamp.size()),
+ 0);
+
+ EXPECT_EQ(hdr.component_bitmap_bit_length, 8);
+ EXPECT_EQ(hdr.package_version_string_type, 1);
+ ASSERT_EQ(hdr.package_version_string.length, 4);
+ EXPECT_EQ(memcmp("test", hdr.package_version_string.ptr,
+ hdr.package_version_string.length),
+ 0);
+ EXPECT_NE(hdr.areas.ptr, nullptr);
+ EXPECT_NE(hdr.areas.length, 0);
+ EXPECT_NE(hdr.package.ptr, nullptr);
+ EXPECT_NE(hdr.package.length, 0);
+
+ foreach_pldm_package_firmware_device_id_record(iter, fdrec, rc)
+ {
+ struct pldm_descriptor desc;
+
+ static const uint8_t expected_reference_manifest_data[] = {0x87, 0x65};
+
+ EXPECT_EQ(fdrec.descriptor_count, 1);
+ EXPECT_EQ(fdrec.device_update_option_flags.value, 0);
+ EXPECT_EQ(fdrec.component_image_set_version_string_type, 1);
+ ASSERT_EQ(fdrec.component_image_set_version_string.length, 4);
+ EXPECT_EQ(memcmp("v0.1", fdrec.component_image_set_version_string.ptr,
+ fdrec.component_image_set_version_string.length),
+ 0);
+ ASSERT_EQ(fdrec.applicable_components.bitmap.length, 1);
+ EXPECT_EQ(*fdrec.applicable_components.bitmap.ptr, 1);
+ EXPECT_NE(fdrec.record_descriptors.length, 0);
+ EXPECT_NE(fdrec.record_descriptors.ptr, nullptr);
+ ASSERT_EQ(fdrec.firmware_device_package_data.length, 0);
+ EXPECT_EQ(fdrec.reference_manifest_data.length,
+ sizeof(expected_reference_manifest_data));
+ EXPECT_EQ(memcmp(fdrec.reference_manifest_data.ptr,
+ expected_reference_manifest_data,
+ sizeof(expected_reference_manifest_data)),
+ 0);
+ foreach_pldm_package_firmware_device_id_record_descriptor(iter, fdrec,
+ desc, rc)
+ {
+ static const uint8_t iana_pen_dmtf[] = {0x9c, 0x01, 0x00, 0x00};
+
+ EXPECT_EQ(desc.descriptor_type, 1);
+ ASSERT_EQ(desc.descriptor_length, sizeof(iana_pen_dmtf));
+ EXPECT_EQ(memcmp(iana_pen_dmtf, desc.descriptor_data,
+ sizeof(iana_pen_dmtf)),
+ 0);
+
+ nr_fdrec_desc++;
+ }
+ ASSERT_EQ(rc, 0);
+
+ nr_fdrec++;
+ }
+ ASSERT_EQ(rc, 0);
+
+ EXPECT_EQ(nr_fdrec, 1);
+ EXPECT_EQ(nr_fdrec_desc, 1);
+
+ foreach_pldm_package_downstream_device_id_record(iter, ddrec, rc)
+ {
+ struct pldm_descriptor desc;
+
+ static const uint8_t expected_reference_manifest_data[] = {0x87, 0x65};
+
+ EXPECT_EQ(ddrec.descriptor_count, 1);
+ EXPECT_EQ(ddrec.update_option_flags.value, 0);
+ EXPECT_EQ(ddrec.self_contained_activation_min_version_string_type, 1);
+ ASSERT_EQ(ddrec.self_contained_activation_min_version_string.length, 4);
+ EXPECT_EQ(
+ memcmp("v1.0",
+ ddrec.self_contained_activation_min_version_string.ptr,
+ ddrec.self_contained_activation_min_version_string.length),
+ 0);
+ EXPECT_EQ(ddrec.self_contained_activation_min_version_comparison_stamp,
+ 0);
+ ASSERT_EQ(ddrec.applicable_components.bitmap.length, 1);
+ EXPECT_EQ(*ddrec.applicable_components.bitmap.ptr, 2);
+ EXPECT_NE(ddrec.record_descriptors.length, 0);
+ EXPECT_NE(ddrec.record_descriptors.ptr, nullptr);
+ EXPECT_EQ(ddrec.package_data.length, 0);
+ EXPECT_EQ(fdrec.reference_manifest_data.length,
+ sizeof(expected_reference_manifest_data));
+ EXPECT_EQ(memcmp(fdrec.reference_manifest_data.ptr,
+ expected_reference_manifest_data,
+ sizeof(expected_reference_manifest_data)),
+ 0);
+
+ foreach_pldm_package_downstream_device_id_record_descriptor(iter, ddrec,
+ desc, rc)
+ {
+ static const uint8_t iana_pen_dmtf[] = {0x9c, 0x01, 0x00, 0x00};
+
+ EXPECT_EQ(desc.descriptor_type, 1);
+ ASSERT_EQ(desc.descriptor_length, sizeof(iana_pen_dmtf));
+ EXPECT_EQ(memcmp(iana_pen_dmtf, desc.descriptor_data,
+ sizeof(iana_pen_dmtf)),
+ 0);
+
+ nr_ddrec_desc++;
+ }
+ ASSERT_EQ(rc, 0);
+
+ nr_ddrec++;
+ }
+ ASSERT_EQ(rc, 0);
+
+ EXPECT_EQ(nr_ddrec, 1);
+ EXPECT_EQ(nr_ddrec_desc, 1);
+
+ static const std::array<const char*, 2> component_versions = {
+ "v0.2",
+ "v2.0",
+ };
+
+ static std::array<uint8_t, 4> expected_opaque_data = {0x12, 0x34, 0x56,
+ 0x78};
+
+ static const std::array<pldm_package_component_image_information, 2>
+ expected_infos{
+ {{0x000a,
+ 0x0000,
+ 0xffffffff,
+ {0},
+ {1},
+ {nullptr, 1},
+ 0x01,
+ {nullptr, 0},
+ {expected_opaque_data.data(), expected_opaque_data.size()}},
+ {0x000a,
+ 0x0000,
+ 0xffffffff,
+ {0},
+ {1},
+ {nullptr, 1},
+ 0x01,
+ {nullptr, 0},
+ {expected_opaque_data.data(), expected_opaque_data.size()}}}};
+ static const std::array<uint8_t, 2> expected_images{0x5a, 0xa5};
+
+ foreach_pldm_package_component_image_information(iter, info, rc)
+ {
+ const struct pldm_package_component_image_information* expected;
+ const char* version;
+ uint8_t image;
+
+ expected = &expected_infos.at(nr_infos);
+ version = component_versions.at(nr_infos);
+ image = expected_images.at(nr_infos);
+
+ EXPECT_EQ(info.component_classification,
+ expected->component_classification);
+ EXPECT_EQ(info.component_identifier, expected->component_identifier);
+ EXPECT_EQ(info.component_comparison_stamp,
+ expected->component_comparison_stamp);
+ EXPECT_EQ(info.component_options.value,
+ expected->component_options.value);
+ EXPECT_EQ(info.requested_component_activation_method.value,
+ expected->requested_component_activation_method.value);
+ EXPECT_NE(info.component_image.ptr, expected->component_image.ptr);
+ EXPECT_EQ(info.component_image.length,
+ expected->component_image.length);
+ EXPECT_EQ(*info.component_image.ptr, image);
+ EXPECT_EQ(info.component_version_string_type,
+ expected->component_version_string_type);
+ ASSERT_EQ(info.component_version_string.length, 4);
+ EXPECT_EQ(memcmp(version, info.component_version_string.ptr,
+ info.component_version_string.length),
+ 0);
+ EXPECT_EQ(info.component_opaque_data.length,
+ expected->component_opaque_data.length);
+ EXPECT_EQ(memcmp(info.component_opaque_data.ptr,
+ expected->component_opaque_data.ptr,
+ expected->component_opaque_data.length),
+ 0);
+
+ nr_infos++;
+ }
+ ASSERT_EQ(rc, 0);
+
+ EXPECT_EQ(nr_infos, 2);
+}
#endif
\ No newline at end of file