firmware_update: Add DSP0267 v1.2.0 version updates
- Added `component_opaque_data` fields to relevant data structures.
- Implemented decode functionality for these fields to correctly
parse their contents.
- Added unit tests for DSP0267 v1.2.0 to verify the new
decoding functionality.
Change-Id: I47a85b5c9f7cc28da6066e88e27e8dc877cc074b
Signed-off-by: Carter Chen <carter.chen.wiwynn@gmail.com>
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 0806efe..1a505e3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -20,6 +20,8 @@
### Added
- base: Add command specific completion codes.
+- firmware update: Add support for DSP0267 v1.2.0 by adding
+ `component_opaque_data` fields to correctly parse their contents.
### Changed
diff --git a/include/libpldm/firmware_update.h b/include/libpldm/firmware_update.h
index 2143c44..9d8cc2a 100644
--- a/include/libpldm/firmware_update.h
+++ b/include/libpldm/firmware_update.h
@@ -2181,6 +2181,16 @@
/** @brief Firmware update v1.1 package header format revision */
#define PLDM_PACKAGE_HEADER_FORMAT_REVISION_FR02H 0x02
+/** @brief Firmware update v1.2 package header identifier */
+#define PLDM_PACKAGE_HEADER_IDENTIFIER_V1_2 \
+ { \
+ 0x31, 0x19, 0xce, 0x2f, 0xe8, 0x0a, 0x4a, 0x99, \
+ 0xaf, 0x6d, 0x46, 0xf8, 0xb1, 0x21, 0xf6, 0xbf, \
+ }
+
+/** @brief Firmware update v1.2 package header format revision */
+#define PLDM_PACKAGE_HEADER_FORMAT_REVISION_FR03H 0x03
+
/** @brief Consumer-side version pinning for package format parsing
*
* Parsing a firmware update package requires the package to be of a revision
@@ -2197,6 +2207,7 @@
*
* - @ref DEFINE_PLDM_PACKAGE_FORMAT_PIN_FR01H
* - @ref DEFINE_PLDM_PACKAGE_FORMAT_PIN_FR02H
+ * - @ref DEFINE_PLDM_PACKAGE_FORMAT_PIN_FR03H
*
* The package pinning operates by providing versioning over multiple structs
* required to perform the package parsing. See [Conventions for extensible
@@ -2371,6 +2382,12 @@
* provided package data.
*/
struct variable_field component_version_string;
+
+ /**
+ * A field that points to the component opaque data in the
+ * provided package data.
+ */
+ struct variable_field component_opaque_data;
};
struct pldm_package_firmware_device_id_record_iter {
@@ -2906,6 +2923,33 @@
} \
}
+/**
+ * Declare consumer support for at most revision 3 of the firmware update
+ * package header
+ *
+ * @param name The name for the pin object
+ *
+ * The pin object must be provided to @ref decode_pldm_firmware_update_package
+ */
+#define DEFINE_PLDM_PACKAGE_FORMAT_PIN_FR03H(name) \
+ struct pldm_package_format_pin name = { \
+ .meta = { \
+ .magic = ( \
+ LIBPLDM_SIZEAT(struct pldm__package_header_information, package) + \
+ LIBPLDM_SIZEAT(struct pldm_package_firmware_device_id_record, firmware_device_package_data) + \
+ LIBPLDM_SIZEAT(struct pldm_descriptor, descriptor_data) + \
+ LIBPLDM_SIZEAT(struct pldm_package_downstream_device_id_record, package_data) + \
+ LIBPLDM_SIZEAT(struct pldm_package_component_image_information, component_opaque_data) + \
+ LIBPLDM_SIZEAT(struct pldm_package_iter, infos) \
+ ), \
+ .version = 0u, \
+ }, \
+ .format = { \
+ .identifier = PLDM_PACKAGE_HEADER_IDENTIFIER_V1_2, \
+ .revision = PLDM_PACKAGE_HEADER_FORMAT_REVISION_FR03H, \
+ } \
+ }
+
#ifdef __cplusplus
}
#endif
diff --git a/src/dsp/firmware_update.c b/src/dsp/firmware_update.c
index a074472..ada373b 100644
--- a/src/dsp/firmware_update.c
+++ b/src/dsp/firmware_update.c
@@ -340,7 +340,7 @@
static const struct pldm_package_header_format_revision_info {
pldm_uuid identifier;
size_t magic;
- } revision_info[1 + PLDM_PACKAGE_HEADER_FORMAT_REVISION_FR02H] = {
+ } revision_info[1 + PLDM_PACKAGE_HEADER_FORMAT_REVISION_FR03H] = {
[0] = {
.identifier = {0},
.magic = 0,
@@ -364,6 +364,16 @@
LIBPLDM_SIZEAT(struct pldm_package_component_image_information, component_version_string) +
LIBPLDM_SIZEAT(struct pldm_package_iter, infos),
},
+ [PLDM_PACKAGE_HEADER_FORMAT_REVISION_FR03H] = { /* PLDM_PACKAGE_HEADER_FORMAT_REVISION_FR03H */
+ .identifier = PLDM_PACKAGE_HEADER_IDENTIFIER_V1_2,
+ .magic =
+ LIBPLDM_SIZEAT(struct pldm__package_header_information, package) +
+ LIBPLDM_SIZEAT(struct pldm_package_firmware_device_id_record, firmware_device_package_data) +
+ LIBPLDM_SIZEAT(struct pldm_descriptor, descriptor_data) +
+ LIBPLDM_SIZEAT(struct pldm_package_downstream_device_id_record, package_data) +
+ LIBPLDM_SIZEAT(struct pldm_package_component_image_information, component_opaque_data) +
+ LIBPLDM_SIZEAT(struct pldm_package_iter, infos),
+ },
};
const struct pldm_package_header_format_revision_info *info;
@@ -384,11 +394,11 @@
return -EINVAL;
}
- if (pin->format.revision > PLDM_PACKAGE_HEADER_FORMAT_REVISION_FR02H) {
+ if (pin->format.revision > PLDM_PACKAGE_HEADER_FORMAT_REVISION_FR03H) {
return -ENOTSUP;
}
static_assert(ARRAY_SIZE(revision_info) ==
- 1 + PLDM_PACKAGE_HEADER_FORMAT_REVISION_FR02H,
+ 1 + PLDM_PACKAGE_HEADER_FORMAT_REVISION_FR03H,
"Mismatched array bounds test");
info = &revision_info[pin->format.revision];
@@ -422,6 +432,10 @@
memcmp(revision_info[PLDM_PACKAGE_HEADER_FORMAT_REVISION_FR02H]
.identifier,
hdr->package_header_identifier,
+ sizeof(hdr->package_header_identifier)) != 0 &&
+ memcmp(revision_info[PLDM_PACKAGE_HEADER_FORMAT_REVISION_FR03H]
+ .identifier,
+ hdr->package_header_identifier,
sizeof(hdr->package_header_identifier)) != 0) {
return pldm_msgbuf_discard(buf, -ENOTSUP);
}
@@ -3429,6 +3443,25 @@
pldm_msgbuf_span_required(buf, info->component_version_string.length,
(void **)&info->component_version_string.ptr);
+ /* Supported in package header revision 1.2 (FR03H) and above. */
+ if (hdr->package_header_format_revision >=
+ PLDM_PACKAGE_HEADER_FORMAT_REVISION_FR03H) {
+ rc = pldm_msgbuf_extract_uint32_to_size(
+ buf, info->component_opaque_data.length);
+ if (rc) {
+ return pldm_msgbuf_discard(buf, rc);
+ }
+ pldm_msgbuf_span_required(
+ buf, info->component_opaque_data.length,
+ (void **)&info->component_opaque_data.ptr);
+ } else {
+ info->component_opaque_data.length = 0;
+ }
+
+ if (info->component_opaque_data.length == 0) {
+ info->component_opaque_data.ptr = NULL;
+ }
+
pldm_msgbuf_span_remaining(buf, (void **)&iter->field.ptr,
&iter->field.length);
diff --git a/tests/dsp/firmware_update.cpp b/tests/dsp/firmware_update.cpp
index 9566af6..4e16552 100644
--- a/tests/dsp/firmware_update.cpp
+++ b/tests/dsp/firmware_update.cpp
@@ -55,6 +55,11 @@
0xa0, 0x30, 0xfc, 0x8a, 0x56, 0x58, 0x7d, 0x5a,
};
+static constexpr std::array<uint8_t, PLDM_FWUP_UUID_LENGTH>
+ PLDM_FWUP_PACKAGE_HEADER_IDENTIFIER_V1_2{0x31, 0x19, 0xce, 0x2f, 0xe8, 0x0a,
+ 0x4a, 0x99, 0xaf, 0x6d, 0x46, 0xf8,
+ 0xb1, 0x21, 0xf6, 0xbf};
+
static constexpr size_t PLDM_FWUP_PACKAGE_HEADER_EMPTY_SIZE_V1_0 = 43;
static constexpr std::array<uint8_t, PLDM_TIMESTAMP104_SIZE>
@@ -5165,7 +5170,8 @@
EXPECT_EQ(nr_ddrec_desc, 0);
static const pldm_package_component_image_information expected_info{
- 0x000a, 0x0000, 0xffffffff, {0}, {1}, {nullptr, 1}, 0x01, {nullptr, 0}};
+ 0x000a, 0x0000, 0xffffffff, {0}, {1},
+ {nullptr, 1}, 0x01, {nullptr, 0}, {nullptr, 0}};
foreach_pldm_package_component_image_information(iter, info, rc)
{
@@ -5366,6 +5372,7 @@
{1},
{nullptr, 1},
0x01,
+ {nullptr, 0},
{nullptr, 0}},
{0x000a,
0x0000,
@@ -5374,6 +5381,7 @@
{1},
{nullptr, 1},
0x01,
+ {nullptr, 0},
{nullptr, 0}}}};
static const std::array<uint8_t, 2> expected_images{0x5a, 0xa5};
@@ -5414,3 +5422,235 @@
EXPECT_EQ(nr_infos, 2);
}
#endif
+
+#ifdef LIBPLDM_API_TESTING
+TEST(DecodePldmFirmwareUpdatePackage, v3h1fd1fdd1dd1ddd2cii)
+{
+ const std::array<uint8_t, 166> package{
+ 0x31, 0x19, 0xce, 0x2f, 0xe8, 0x0a, 0x4a, 0x99, 0xaf, 0x6d, 0x46, 0xf8,
+ 0xb1, 0x21, 0xf6, 0xbf, 0x03, 0xA4, 0x00, 0x00, 0xe9, 0x07, 0x03, 0x0b,
+ 0x16, 0x03, 0x00, 0x00, 0x00, 0x00, 0x76, 0x02, 0x08, 0x00, 0x01, 0x04,
+ 't', 'e', 's', 't',
+
+ 0x01, 0x18, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x01, 0x04, 0x00, 0x00,
+ 0x01, 'v', '0', '.', '1', 0x01, 0x00, 0x04, 0x00, 0x9c, 0x01, 0x00,
+ 0x00,
+
+ 0x01, 0x18, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x01, 0x04, 0x00, 0x00,
+ 0x02, 'v', '1', '.', '0', 0x01, 0x00, 0x04, 0x00, 0x9c, 0x01, 0x00,
+ 0x00,
+
+ 0x02, 0x00,
+
+ 0x0a, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x01, 0x00,
+ 0xA4, 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,
+ 0xA5, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x04, 'v', '2',
+ '.', '0', 0x04, 0x00, 0x00, 0x00, 0x12, 0x34, 0x56, 0x78,
+
+ 0xed, 0x9d, 0x97, 0x7a,
+
+ 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_FR03H(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_2.data(),
+ hdr.package_header_identifier,
+ PLDM_FWUP_PACKAGE_HEADER_IDENTIFIER_V1_2.size()),
+ 0);
+ EXPECT_EQ(hdr.package_header_format_revision, 3);
+
+ 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;
+
+ 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);
+
+ 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;
+
+ 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);
+
+ 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