Patrick Williams | 691668f | 2023-11-01 08:19:10 -0500 | [diff] [blame] | 1 | /* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later */ |
Andrew Jeffery | 830c1eb | 2024-10-04 10:48:10 +0930 | [diff] [blame] | 2 | #include "api.h" |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 3 | #include "dsp/base.h" |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 4 | #include "msgbuf.h" |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 5 | #include <libpldm/base.h> |
Andrew Jeffery | b0c1d20 | 2023-11-07 22:08:44 +1030 | [diff] [blame] | 6 | #include <libpldm/firmware_update.h> |
| 7 | #include <libpldm/utils.h> |
| 8 | |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 9 | #include <endian.h> |
Manojkiran Eda | 9a8e497 | 2022-11-28 16:38:21 +0530 | [diff] [blame] | 10 | #include <stdbool.h> |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 11 | #include <string.h> |
| 12 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 13 | static_assert(PLDM_FIRMWARE_MAX_STRING <= UINT8_MAX, "too large"); |
| 14 | |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 15 | /** @brief Check whether string type value is valid |
| 16 | * |
| 17 | * @return true if string type value is valid, false if not |
| 18 | */ |
| 19 | static bool is_string_type_valid(uint8_t string_type) |
| 20 | { |
| 21 | switch (string_type) { |
| 22 | case PLDM_STR_TYPE_UNKNOWN: |
| 23 | return false; |
| 24 | case PLDM_STR_TYPE_ASCII: |
| 25 | case PLDM_STR_TYPE_UTF_8: |
| 26 | case PLDM_STR_TYPE_UTF_16: |
| 27 | case PLDM_STR_TYPE_UTF_16LE: |
| 28 | case PLDM_STR_TYPE_UTF_16BE: |
| 29 | return true; |
| 30 | default: |
| 31 | return false; |
| 32 | } |
| 33 | } |
| 34 | |
| 35 | /** @brief Return the length of the descriptor type described in firmware update |
| 36 | * specification |
| 37 | * |
| 38 | * @return length of the descriptor type if descriptor type is valid else |
| 39 | * return 0 |
| 40 | */ |
| 41 | static uint16_t get_descriptor_type_length(uint16_t descriptor_type) |
| 42 | { |
| 43 | switch (descriptor_type) { |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 44 | case PLDM_FWUP_PCI_VENDOR_ID: |
| 45 | return PLDM_FWUP_PCI_VENDOR_ID_LENGTH; |
| 46 | case PLDM_FWUP_IANA_ENTERPRISE_ID: |
| 47 | return PLDM_FWUP_IANA_ENTERPRISE_ID_LENGTH; |
| 48 | case PLDM_FWUP_UUID: |
| 49 | return PLDM_FWUP_UUID_LENGTH; |
| 50 | case PLDM_FWUP_PNP_VENDOR_ID: |
| 51 | return PLDM_FWUP_PNP_VENDOR_ID_LENGTH; |
| 52 | case PLDM_FWUP_ACPI_VENDOR_ID: |
| 53 | return PLDM_FWUP_ACPI_VENDOR_ID_LENGTH; |
| 54 | case PLDM_FWUP_IEEE_ASSIGNED_COMPANY_ID: |
| 55 | return PLDM_FWUP_IEEE_ASSIGNED_COMPANY_ID_LENGTH; |
| 56 | case PLDM_FWUP_SCSI_VENDOR_ID: |
| 57 | return PLDM_FWUP_SCSI_VENDOR_ID_LENGTH; |
| 58 | case PLDM_FWUP_PCI_DEVICE_ID: |
| 59 | return PLDM_FWUP_PCI_DEVICE_ID_LENGTH; |
| 60 | case PLDM_FWUP_PCI_SUBSYSTEM_VENDOR_ID: |
| 61 | return PLDM_FWUP_PCI_SUBSYSTEM_VENDOR_ID_LENGTH; |
| 62 | case PLDM_FWUP_PCI_SUBSYSTEM_ID: |
| 63 | return PLDM_FWUP_PCI_SUBSYSTEM_ID_LENGTH; |
| 64 | case PLDM_FWUP_PCI_REVISION_ID: |
| 65 | return PLDM_FWUP_PCI_REVISION_ID_LENGTH; |
| 66 | case PLDM_FWUP_PNP_PRODUCT_IDENTIFIER: |
| 67 | return PLDM_FWUP_PNP_PRODUCT_IDENTIFIER_LENGTH; |
| 68 | case PLDM_FWUP_ACPI_PRODUCT_IDENTIFIER: |
| 69 | return PLDM_FWUP_ACPI_PRODUCT_IDENTIFIER_LENGTH; |
| 70 | case PLDM_FWUP_ASCII_MODEL_NUMBER_LONG_STRING: |
| 71 | return PLDM_FWUP_ASCII_MODEL_NUMBER_LONG_STRING_LENGTH; |
| 72 | case PLDM_FWUP_ASCII_MODEL_NUMBER_SHORT_STRING: |
| 73 | return PLDM_FWUP_ASCII_MODEL_NUMBER_SHORT_STRING_LENGTH; |
| 74 | case PLDM_FWUP_SCSI_PRODUCT_ID: |
| 75 | return PLDM_FWUP_SCSI_PRODUCT_ID_LENGTH; |
| 76 | case PLDM_FWUP_UBM_CONTROLLER_DEVICE_CODE: |
| 77 | return PLDM_FWUP_UBM_CONTROLLER_DEVICE_CODE_LENGTH; |
| 78 | default: |
| 79 | return 0; |
| 80 | } |
| 81 | } |
| 82 | |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 83 | static bool is_downstream_device_update_support_valid(uint8_t resp) |
| 84 | { |
| 85 | switch (resp) { |
| 86 | case PLDM_FWUP_DOWNSTREAM_DEVICE_UPDATE_NOT_SUPPORTED: |
| 87 | case PLDM_FWUP_DOWNSTREAM_DEVICE_UPDATE_SUPPORTED: |
| 88 | return true; |
| 89 | default: |
| 90 | return false; |
| 91 | } |
| 92 | } |
| 93 | |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 94 | static bool |
| 95 | is_transfer_operation_flag_valid(enum transfer_op_flag transfer_op_flag) |
| 96 | { |
| 97 | switch (transfer_op_flag) { |
| 98 | case PLDM_GET_NEXTPART: |
| 99 | case PLDM_GET_FIRSTPART: |
| 100 | return true; |
| 101 | default: |
| 102 | return false; |
| 103 | } |
| 104 | } |
| 105 | |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 106 | /** @brief Check whether ComponentResponse is valid |
| 107 | * |
| 108 | * @return true if ComponentResponse is valid, false if not |
| 109 | */ |
| 110 | static bool is_comp_resp_valid(uint8_t comp_resp) |
| 111 | { |
| 112 | switch (comp_resp) { |
| 113 | case PLDM_CR_COMP_CAN_BE_UPDATED: |
| 114 | case PLDM_CR_COMP_MAY_BE_UPDATEABLE: |
| 115 | return true; |
| 116 | |
| 117 | default: |
| 118 | return false; |
| 119 | } |
| 120 | } |
| 121 | |
| 122 | /** @brief Check whether ComponentResponseCode is valid |
| 123 | * |
| 124 | * @return true if ComponentResponseCode is valid, false if not |
| 125 | */ |
| 126 | static bool is_comp_resp_code_valid(uint8_t comp_resp_code) |
| 127 | { |
| 128 | switch (comp_resp_code) { |
| 129 | case PLDM_CRC_COMP_CAN_BE_UPDATED: |
| 130 | case PLDM_CRC_COMP_COMPARISON_STAMP_IDENTICAL: |
| 131 | case PLDM_CRC_COMP_COMPARISON_STAMP_LOWER: |
| 132 | case PLDM_CRC_INVALID_COMP_COMPARISON_STAMP: |
| 133 | case PLDM_CRC_COMP_CONFLICT: |
| 134 | case PLDM_CRC_COMP_PREREQUISITES_NOT_MET: |
| 135 | case PLDM_CRC_COMP_NOT_SUPPORTED: |
| 136 | case PLDM_CRC_COMP_SECURITY_RESTRICTIONS: |
| 137 | case PLDM_CRC_INCOMPLETE_COMP_IMAGE_SET: |
| 138 | case PLDM_CRC_ACTIVE_IMAGE_NOT_UPDATEABLE_SUBSEQUENTLY: |
| 139 | case PLDM_CRC_COMP_VER_STR_IDENTICAL: |
| 140 | case PLDM_CRC_COMP_VER_STR_LOWER: |
| 141 | return true; |
| 142 | |
| 143 | default: |
| 144 | if (comp_resp_code >= |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 145 | PLDM_CRC_VENDOR_COMP_RESP_CODE_RANGE_MIN && |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 146 | comp_resp_code <= |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 147 | PLDM_CRC_VENDOR_COMP_RESP_CODE_RANGE_MAX) { |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 148 | return true; |
| 149 | } |
| 150 | return false; |
| 151 | } |
| 152 | } |
| 153 | |
| 154 | /** @brief Check whether ComponentCompatibilityResponse is valid |
| 155 | * |
| 156 | * @return true if ComponentCompatibilityResponse is valid, false if not |
| 157 | */ |
| 158 | static bool is_comp_compatibility_resp_valid(uint8_t comp_compatibility_resp) |
| 159 | { |
| 160 | switch (comp_compatibility_resp) { |
| 161 | case PLDM_CCR_COMP_CAN_BE_UPDATED: |
| 162 | case PLDM_CCR_COMP_CANNOT_BE_UPDATED: |
| 163 | return true; |
| 164 | |
| 165 | default: |
| 166 | return false; |
| 167 | } |
| 168 | } |
| 169 | |
| 170 | /** @brief Check whether ComponentCompatibilityResponse Code is valid |
| 171 | * |
| 172 | * @return true if ComponentCompatibilityResponse Code is valid, false if not |
| 173 | */ |
| 174 | static bool |
| 175 | is_comp_compatibility_resp_code_valid(uint8_t comp_compatibility_resp_code) |
| 176 | { |
| 177 | switch (comp_compatibility_resp_code) { |
| 178 | case PLDM_CCRC_NO_RESPONSE_CODE: |
| 179 | case PLDM_CCRC_COMP_COMPARISON_STAMP_IDENTICAL: |
| 180 | case PLDM_CCRC_COMP_COMPARISON_STAMP_LOWER: |
| 181 | case PLDM_CCRC_INVALID_COMP_COMPARISON_STAMP: |
| 182 | case PLDM_CCRC_COMP_CONFLICT: |
| 183 | case PLDM_CCRC_COMP_PREREQUISITES_NOT_MET: |
| 184 | case PLDM_CCRC_COMP_NOT_SUPPORTED: |
| 185 | case PLDM_CCRC_COMP_SECURITY_RESTRICTIONS: |
| 186 | case PLDM_CRC_INCOMPLETE_COMP_IMAGE_SET: |
| 187 | case PLDM_CCRC_COMP_INFO_NO_MATCH: |
| 188 | case PLDM_CCRC_COMP_VER_STR_IDENTICAL: |
| 189 | case PLDM_CCRC_COMP_VER_STR_LOWER: |
| 190 | return true; |
| 191 | |
| 192 | default: |
| 193 | if (comp_compatibility_resp_code >= |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 194 | PLDM_CCRC_VENDOR_COMP_RESP_CODE_RANGE_MIN && |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 195 | comp_compatibility_resp_code <= |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 196 | PLDM_CCRC_VENDOR_COMP_RESP_CODE_RANGE_MAX) { |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 197 | return true; |
| 198 | } |
| 199 | return false; |
| 200 | } |
| 201 | } |
| 202 | |
| 203 | /** @brief Check whether SelfContainedActivationRequest is valid |
| 204 | * |
| 205 | * @return true if SelfContainedActivationRequest is valid, false if not |
| 206 | */ |
| 207 | static bool |
| 208 | is_self_contained_activation_req_valid(bool8_t self_contained_activation_req) |
| 209 | { |
| 210 | switch (self_contained_activation_req) { |
| 211 | case PLDM_NOT_ACTIVATE_SELF_CONTAINED_COMPONENTS: |
| 212 | case PLDM_ACTIVATE_SELF_CONTAINED_COMPONENTS: |
| 213 | return true; |
| 214 | |
| 215 | default: |
| 216 | return false; |
| 217 | } |
| 218 | } |
| 219 | |
| 220 | /** @brief Check if current or previous status in GetStatus command response is |
| 221 | * valid |
| 222 | * |
| 223 | * @param[in] state - current or previous different state machine state of |
| 224 | * the FD |
| 225 | * @return true if state is valid, false if not |
| 226 | */ |
| 227 | static bool is_state_valid(uint8_t state) |
| 228 | { |
| 229 | switch (state) { |
| 230 | case PLDM_FD_STATE_IDLE: |
| 231 | case PLDM_FD_STATE_LEARN_COMPONENTS: |
| 232 | case PLDM_FD_STATE_READY_XFER: |
| 233 | case PLDM_FD_STATE_DOWNLOAD: |
| 234 | case PLDM_FD_STATE_VERIFY: |
| 235 | case PLDM_FD_STATE_APPLY: |
| 236 | case PLDM_FD_STATE_ACTIVATE: |
| 237 | return true; |
| 238 | |
| 239 | default: |
| 240 | return false; |
| 241 | } |
| 242 | } |
| 243 | |
| 244 | /** @brief Check if aux state in GetStatus command response is valid |
| 245 | * |
| 246 | * @param[in] aux_state - provides additional information to the UA to describe |
| 247 | * the current operation state of the FD/FDP |
| 248 | * |
| 249 | * @return true if aux state is valid, false if not |
| 250 | */ |
| 251 | static bool is_aux_state_valid(uint8_t aux_state) |
| 252 | { |
| 253 | switch (aux_state) { |
| 254 | case PLDM_FD_OPERATION_IN_PROGRESS: |
| 255 | case PLDM_FD_OPERATION_SUCCESSFUL: |
| 256 | case PLDM_FD_OPERATION_FAILED: |
| 257 | case PLDM_FD_IDLE_LEARN_COMPONENTS_READ_XFER: |
| 258 | return true; |
| 259 | |
| 260 | default: |
| 261 | return false; |
| 262 | } |
| 263 | } |
| 264 | |
| 265 | /** @brief Check if aux state status in GetStatus command response is valid |
| 266 | * |
| 267 | * @param[in] aux_state_status - aux state status |
| 268 | * |
| 269 | * @return true if aux state status is valid, false if not |
| 270 | */ |
| 271 | static bool is_aux_state_status_valid(uint8_t aux_state_status) |
| 272 | { |
| 273 | if (aux_state_status == PLDM_FD_AUX_STATE_IN_PROGRESS_OR_SUCCESS || |
| 274 | aux_state_status == PLDM_FD_TIMEOUT || |
Andrew Jeffery | 67f7ed9 | 2023-04-05 14:00:00 +0930 | [diff] [blame] | 275 | aux_state_status == PLDM_FD_GENERIC_ERROR || |
| 276 | (aux_state_status >= PLDM_FD_VENDOR_DEFINED_STATUS_CODE_START && |
| 277 | aux_state_status <= PLDM_FD_VENDOR_DEFINED_STATUS_CODE_END)) { |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 278 | return true; |
| 279 | } |
| 280 | |
| 281 | return false; |
| 282 | } |
| 283 | |
| 284 | /** @brief Check if reason code in GetStatus command response is valid |
| 285 | * |
| 286 | * @param[in] reason_code - provides the reason for why the current state |
| 287 | * entered the IDLE state |
| 288 | * |
| 289 | * @return true if reason code is valid, false if not |
| 290 | */ |
| 291 | static bool is_reason_code_valid(uint8_t reason_code) |
| 292 | { |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 293 | switch (reason_code) { |
| 294 | case PLDM_FD_INITIALIZATION: |
| 295 | case PLDM_FD_ACTIVATE_FW: |
| 296 | case PLDM_FD_CANCEL_UPDATE: |
| 297 | case PLDM_FD_TIMEOUT_LEARN_COMPONENT: |
| 298 | case PLDM_FD_TIMEOUT_READY_XFER: |
| 299 | case PLDM_FD_TIMEOUT_DOWNLOAD: |
| 300 | case PLDM_FD_TIMEOUT_VERIFY: |
| 301 | case PLDM_FD_TIMEOUT_APPLY: |
| 302 | return true; |
| 303 | |
| 304 | default: |
| 305 | if (reason_code >= PLDM_FD_STATUS_VENDOR_DEFINED_MIN) { |
| 306 | return true; |
| 307 | } |
| 308 | return false; |
| 309 | } |
| 310 | } |
| 311 | |
| 312 | /** @brief Check if non functioning component indication in CancelUpdate |
| 313 | * response is valid |
| 314 | * |
| 315 | * @return true if non functioning component indication is valid, false if not |
| 316 | */ |
| 317 | static bool is_non_functioning_component_indication_valid( |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 318 | bool8_t non_functioning_component_indication) |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 319 | { |
| 320 | switch (non_functioning_component_indication) { |
| 321 | case PLDM_FWUP_COMPONENTS_FUNCTIONING: |
| 322 | case PLDM_FWUP_COMPONENTS_NOT_FUNCTIONING: |
| 323 | return true; |
| 324 | |
| 325 | default: |
| 326 | return false; |
| 327 | } |
| 328 | } |
| 329 | |
Andrew Jeffery | 150b06c | 2025-03-12 14:17:42 +1030 | [diff] [blame] | 330 | // Identifier for a valid PLDM Firmware Update Package for Version 1.0.x as per |
| 331 | // spec |
| 332 | static const uint8_t PLDM_FWUP_HDR_IDENTIFIER_V1[PLDM_FWUP_UUID_LENGTH] = { |
| 333 | 0xF0, 0x18, 0x87, 0x8C, 0xCB, 0x7D, 0x49, 0x43, |
| 334 | 0x98, 0x00, 0xA0, 0x2F, 0x05, 0x9A, 0xCA, 0x02 |
| 335 | }; |
| 336 | |
| 337 | /* TODO: Remove struct pldm_package_header_information from public header, rename padded struct, drop typedef */ |
| 338 | struct pldm__package_header_information { |
| 339 | uint8_t package_header_identifier[PLDM_FWUP_UUID_LENGTH]; |
| 340 | uint8_t package_header_format_revision; |
| 341 | uint8_t package_release_date_time[PLDM_TIMESTAMP104_SIZE]; |
| 342 | uint16_t component_bitmap_bit_length; |
| 343 | uint8_t package_version_string_type; |
| 344 | struct variable_field package_version_string; |
| 345 | struct variable_field areas; |
| 346 | struct variable_field images; |
| 347 | }; |
| 348 | typedef struct pldm__package_header_information |
| 349 | pldm_package_header_information_pad; |
| 350 | |
| 351 | #define PLDM_FWUP_PACKAGE_HEADER_FIXED_SIZE 36 |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 352 | static int decode_pldm_package_header_info_errno( |
Andrew Jeffery | 0ba6aa0 | 2025-03-06 11:22:37 +1030 | [diff] [blame] | 353 | const void *data, size_t length, |
Andrew Jeffery | 150b06c | 2025-03-12 14:17:42 +1030 | [diff] [blame] | 354 | pldm_package_header_information_pad *header) |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 355 | { |
Andrew Jeffery | 150b06c | 2025-03-12 14:17:42 +1030 | [diff] [blame] | 356 | uint32_t package_header_checksum = 0; |
| 357 | size_t package_header_variable_size; |
| 358 | size_t package_header_payload_size; |
| 359 | size_t package_header_areas_size; |
| 360 | uint16_t package_header_size; |
| 361 | PLDM_MSGBUF_DEFINE_P(buf); |
| 362 | int checksums = 1; |
| 363 | int rc; |
| 364 | |
| 365 | if (!data || !header) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 366 | return -EINVAL; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 367 | } |
| 368 | |
Andrew Jeffery | 150b06c | 2025-03-12 14:17:42 +1030 | [diff] [blame] | 369 | rc = pldm_msgbuf_init_errno(buf, PLDM_FWUP_PACKAGE_HEADER_FIXED_SIZE, |
| 370 | data, length); |
| 371 | if (rc) { |
| 372 | return rc; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 373 | } |
| 374 | |
Andrew Jeffery | 150b06c | 2025-03-12 14:17:42 +1030 | [diff] [blame] | 375 | rc = pldm_msgbuf_extract_array( |
| 376 | buf, sizeof(header->package_header_identifier), |
| 377 | header->package_header_identifier, |
| 378 | sizeof(header->package_header_identifier)); |
| 379 | if (rc) { |
| 380 | return pldm_msgbuf_discard(buf, rc); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 381 | } |
| 382 | |
Andrew Jeffery | 150b06c | 2025-03-12 14:17:42 +1030 | [diff] [blame] | 383 | static_assert(sizeof(PLDM_FWUP_HDR_IDENTIFIER_V1) == |
| 384 | sizeof(header->package_header_identifier), |
| 385 | "UUID field size"); |
| 386 | if (memcmp(PLDM_FWUP_HDR_IDENTIFIER_V1, |
| 387 | header->package_header_identifier, |
| 388 | sizeof(PLDM_FWUP_HDR_IDENTIFIER_V1)) != 0) { |
| 389 | return pldm_msgbuf_discard(buf, -ENOTSUP); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 390 | } |
| 391 | |
Andrew Jeffery | 150b06c | 2025-03-12 14:17:42 +1030 | [diff] [blame] | 392 | rc = pldm_msgbuf_extract(buf, header->package_header_format_revision); |
| 393 | if (rc) { |
| 394 | return pldm_msgbuf_discard(buf, rc); |
| 395 | } |
| 396 | if (header->package_header_format_revision != 0x01) { |
| 397 | return pldm_msgbuf_discard(buf, -EBADMSG); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 398 | } |
| 399 | |
Andrew Jeffery | 150b06c | 2025-03-12 14:17:42 +1030 | [diff] [blame] | 400 | rc = pldm_msgbuf_extract(buf, package_header_size); |
| 401 | if (rc) { |
| 402 | return pldm_msgbuf_discard(buf, rc); |
| 403 | } |
| 404 | |
| 405 | rc = pldm_msgbuf_extract_array( |
| 406 | buf, sizeof(header->package_release_date_time), |
| 407 | header->package_release_date_time, |
| 408 | sizeof(header->package_release_date_time)); |
| 409 | if (rc) { |
| 410 | return pldm_msgbuf_discard(buf, rc); |
| 411 | } |
| 412 | |
| 413 | rc = pldm_msgbuf_extract(buf, header->component_bitmap_bit_length); |
| 414 | if (rc) { |
| 415 | return pldm_msgbuf_discard(buf, rc); |
| 416 | } |
| 417 | if (header->component_bitmap_bit_length & 7) { |
| 418 | return pldm_msgbuf_discard(buf, -EPROTO); |
| 419 | } |
| 420 | |
| 421 | rc = pldm_msgbuf_extract(buf, header->package_version_string_type); |
| 422 | if (rc) { |
| 423 | return pldm_msgbuf_discard(buf, rc); |
| 424 | } |
| 425 | if (!is_string_type_valid(header->package_version_string_type)) { |
| 426 | return pldm_msgbuf_discard(buf, -EPROTO); |
| 427 | } |
| 428 | |
| 429 | rc = pldm_msgbuf_extract_uint8_to_size( |
| 430 | buf, header->package_version_string.length); |
| 431 | if (rc) { |
| 432 | return pldm_msgbuf_discard(buf, rc); |
| 433 | } |
| 434 | if (header->package_version_string.length == 0) { |
| 435 | return pldm_msgbuf_discard(buf, -EBADMSG); |
| 436 | } |
| 437 | |
| 438 | pldm_msgbuf_span_required(buf, header->package_version_string.length, |
| 439 | (void **)&header->package_version_string.ptr); |
| 440 | |
| 441 | if (package_header_size < (PLDM_FWUP_PACKAGE_HEADER_FIXED_SIZE + 3 + |
| 442 | checksums * sizeof(uint32_t))) { |
| 443 | return pldm_msgbuf_discard(buf, -EBADMSG); |
| 444 | } |
| 445 | package_header_payload_size = |
| 446 | package_header_size - (checksums * sizeof(uint32_t)); |
| 447 | package_header_variable_size = package_header_payload_size - |
| 448 | PLDM_FWUP_PACKAGE_HEADER_FIXED_SIZE; |
| 449 | |
| 450 | if (package_header_variable_size < |
| 451 | header->package_version_string.length) { |
| 452 | return pldm_msgbuf_discard(buf, -EOVERFLOW); |
| 453 | } |
| 454 | |
| 455 | package_header_areas_size = package_header_variable_size - |
| 456 | header->package_version_string.length; |
| 457 | rc = pldm_msgbuf_span_required(buf, package_header_areas_size, |
| 458 | (void **)&header->areas.ptr); |
| 459 | if (rc) { |
| 460 | return pldm_msgbuf_discard(buf, rc); |
| 461 | } |
| 462 | header->areas.length = package_header_areas_size; |
| 463 | |
| 464 | pldm_msgbuf_extract(buf, package_header_checksum); |
| 465 | |
| 466 | rc = pldm_msgbuf_complete(buf); |
| 467 | if (rc) { |
| 468 | return rc; |
| 469 | } |
| 470 | |
| 471 | if (package_header_checksum != |
| 472 | crc32(data, package_header_payload_size)) { |
| 473 | return -EUCLEAN; |
| 474 | } |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 475 | |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 476 | return 0; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 477 | } |
| 478 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 479 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 480 | int decode_pldm_package_header_info( |
| 481 | const uint8_t *data, size_t length, |
| 482 | struct pldm_package_header_information *package_header_info, |
| 483 | struct variable_field *package_version_str) |
| 484 | { |
Andrew Jeffery | 150b06c | 2025-03-12 14:17:42 +1030 | [diff] [blame] | 485 | pldm_package_header_information_pad header; |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 486 | int rc; |
| 487 | |
Andrew Jeffery | 150b06c | 2025-03-12 14:17:42 +1030 | [diff] [blame] | 488 | if (!data || !package_header_info || !package_version_str) { |
| 489 | return PLDM_ERROR_INVALID_DATA; |
| 490 | } |
| 491 | |
| 492 | rc = decode_pldm_package_header_info_errno(data, length, &header); |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 493 | if (rc < 0) { |
| 494 | return pldm_xlate_errno(rc); |
| 495 | } |
| 496 | |
Andrew Jeffery | 150b06c | 2025-03-12 14:17:42 +1030 | [diff] [blame] | 497 | static_assert(sizeof(package_header_info->uuid) == |
| 498 | sizeof(header.package_header_identifier), |
| 499 | "UUID field size"); |
| 500 | memcpy(package_header_info->uuid, header.package_header_identifier, |
| 501 | sizeof(header.package_header_identifier)); |
| 502 | package_header_info->package_header_format_version = |
| 503 | header.package_header_format_revision; |
| 504 | memcpy(&package_header_info->package_header_size, data + 17, |
| 505 | sizeof(package_header_info->package_header_size)); |
| 506 | LE16TOH(package_header_info->package_header_size); |
| 507 | static_assert(sizeof(package_header_info->package_release_date_time) == |
| 508 | sizeof(header.package_release_date_time), |
| 509 | "TIMESTAMP104 field size"); |
| 510 | memcpy(package_header_info->package_release_date_time, |
| 511 | header.package_release_date_time, |
| 512 | sizeof(header.package_release_date_time)); |
| 513 | package_header_info->component_bitmap_bit_length = |
| 514 | header.component_bitmap_bit_length; |
| 515 | package_header_info->package_version_string_type = |
| 516 | header.package_version_string_type; |
| 517 | package_header_info->package_version_string_length = |
| 518 | header.package_version_string.length; |
| 519 | *package_version_str = header.package_version_string; |
| 520 | |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 521 | return PLDM_SUCCESS; |
| 522 | } |
| 523 | |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 524 | struct pldm_component_bitmap { |
| 525 | struct variable_field bitmap; |
| 526 | }; |
| 527 | |
| 528 | /* TODO: Remove struct pldm_firmware_device_id_record from public header, rename padded struct, drop typedef */ |
| 529 | struct pldm__firmware_device_id_record { |
| 530 | uint8_t descriptor_count; |
| 531 | bitfield32_t device_update_option_flags; |
| 532 | uint8_t component_image_set_version_string_type; |
| 533 | struct variable_field component_image_set_version_string; |
| 534 | struct pldm_component_bitmap applicable_components; |
| 535 | struct variable_field record_descriptors; |
| 536 | struct variable_field firmware_device_package_data; |
| 537 | }; |
| 538 | typedef struct pldm__firmware_device_id_record |
| 539 | pldm_firmware_device_id_record_pad; |
| 540 | |
| 541 | /* Currently only used for decode_firmware_device_id_record_errno() */ |
| 542 | static int pldm_msgbuf_init_dynamic_uint16(struct pldm_msgbuf *buf, size_t req, |
| 543 | const void *data, size_t len) |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 544 | { |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 545 | uint16_t dyn; |
| 546 | void *start; |
| 547 | int rc; |
| 548 | |
| 549 | /* |
| 550 | * Extract the record length from the first field, then reinitialise the msgbuf |
| 551 | * after determining that it's safe to do so |
| 552 | */ |
| 553 | |
| 554 | rc = pldm_msgbuf_init_errno(buf, req, data, len); |
| 555 | if (rc) { |
| 556 | return rc; |
| 557 | } |
| 558 | |
| 559 | rc = pldm_msgbuf_extract(buf, dyn); |
| 560 | if (rc) { |
| 561 | return pldm_msgbuf_discard(buf, rc); |
| 562 | } |
| 563 | |
| 564 | rc = pldm_msgbuf_complete(buf); |
| 565 | if (rc) { |
| 566 | return rc; |
| 567 | } |
| 568 | |
| 569 | rc = pldm_msgbuf_init_errno(buf, req, data, len); |
| 570 | if (rc) { |
| 571 | return rc; |
| 572 | } |
| 573 | |
| 574 | /* Ensure there's no arithmetic funkiness and the span is within buffer bounds */ |
| 575 | rc = pldm_msgbuf_span_required(buf, dyn, &start); |
| 576 | if (rc) { |
| 577 | return pldm_msgbuf_discard(buf, rc); |
| 578 | } |
| 579 | |
| 580 | rc = pldm_msgbuf_complete(buf); |
| 581 | if (rc) { |
| 582 | return rc; |
| 583 | } |
| 584 | |
| 585 | return pldm_msgbuf_init_errno(buf, req, start, dyn); |
| 586 | } |
| 587 | |
| 588 | #define PLDM_FWUP_FIRMWARE_DEVICE_ID_RECORD_MIN_SIZE 11 |
| 589 | static int decode_firmware_device_id_record_errno( |
| 590 | const void *data, size_t length, |
| 591 | pldm_package_header_information_pad *header, |
| 592 | pldm_firmware_device_id_record_pad *rec) |
| 593 | { |
| 594 | PLDM_MSGBUF_DEFINE_P(buf); |
| 595 | uint16_t record_len = 0; |
| 596 | int rc; |
| 597 | |
| 598 | if (!data || !header || !rec) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 599 | return -EINVAL; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 600 | } |
| 601 | |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 602 | if (header->package_header_format_revision != 1) { |
| 603 | return -ENOTSUP; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 604 | } |
| 605 | |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 606 | if (header->component_bitmap_bit_length & 7) { |
| 607 | return -EPROTO; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 608 | } |
| 609 | |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 610 | rc = pldm_msgbuf_init_dynamic_uint16( |
| 611 | buf, PLDM_FWUP_FIRMWARE_DEVICE_ID_RECORD_MIN_SIZE, data, |
| 612 | length); |
| 613 | if (rc) { |
| 614 | return rc; |
| 615 | } |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 616 | |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 617 | pldm_msgbuf_extract(buf, record_len); |
| 618 | pldm_msgbuf_extract(buf, rec->descriptor_count); |
| 619 | pldm_msgbuf_extract(buf, rec->device_update_option_flags.value); |
| 620 | |
| 621 | rc = pldm_msgbuf_extract(buf, |
| 622 | rec->component_image_set_version_string_type); |
| 623 | if (rc) { |
| 624 | return pldm_msgbuf_discard(buf, rc); |
| 625 | } |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 626 | if (!is_string_type_valid( |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 627 | rec->component_image_set_version_string_type)) { |
| 628 | return pldm_msgbuf_discard(buf, -EPROTO); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 629 | } |
| 630 | |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 631 | rc = pldm_msgbuf_extract_uint8_to_size( |
| 632 | buf, rec->component_image_set_version_string.length); |
| 633 | if (rc) { |
| 634 | return pldm_msgbuf_discard(buf, rc); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 635 | } |
| 636 | |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 637 | if (rec->component_image_set_version_string.length == 0) { |
| 638 | return pldm_msgbuf_discard(buf, -EPROTO); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 639 | } |
| 640 | |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 641 | rc = pldm_msgbuf_extract_uint16_to_size( |
| 642 | buf, rec->firmware_device_package_data.length); |
| 643 | if (rc) { |
| 644 | return pldm_msgbuf_discard(buf, rc); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 645 | } |
| 646 | |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 647 | rc = pldm_msgbuf_span_required( |
| 648 | buf, header->component_bitmap_bit_length / 8, |
| 649 | (void **)&rec->applicable_components.bitmap.ptr); |
| 650 | if (rc) { |
| 651 | return pldm_msgbuf_discard(buf, rc); |
| 652 | } |
| 653 | rec->applicable_components.bitmap.length = |
| 654 | header->component_bitmap_bit_length / 8; |
| 655 | |
| 656 | pldm_msgbuf_span_required( |
| 657 | buf, rec->component_image_set_version_string.length, |
| 658 | (void **)&rec->component_image_set_version_string.ptr); |
| 659 | |
| 660 | pldm_msgbuf_span_until(buf, rec->firmware_device_package_data.length, |
| 661 | (void **)&rec->record_descriptors.ptr, |
| 662 | &rec->record_descriptors.length); |
| 663 | |
| 664 | pldm_msgbuf_span_required( |
| 665 | buf, rec->firmware_device_package_data.length, |
| 666 | (void **)&rec->firmware_device_package_data.ptr); |
| 667 | if (!rec->firmware_device_package_data.length) { |
| 668 | rec->firmware_device_package_data.ptr = NULL; |
| 669 | } |
| 670 | |
| 671 | return pldm_msgbuf_complete_consumed(buf); |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 672 | } |
| 673 | |
| 674 | LIBPLDM_ABI_STABLE |
| 675 | int decode_firmware_device_id_record( |
| 676 | const uint8_t *data, size_t length, |
| 677 | uint16_t component_bitmap_bit_length, |
| 678 | struct pldm_firmware_device_id_record *fw_device_id_record, |
| 679 | struct variable_field *applicable_components, |
| 680 | struct variable_field *comp_image_set_version_str, |
| 681 | struct variable_field *record_descriptors, |
| 682 | struct variable_field *fw_device_pkg_data) |
| 683 | { |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 684 | pldm_package_header_information_pad header = { 0 }; |
| 685 | pldm_firmware_device_id_record_pad rec = { 0 }; |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 686 | int rc; |
| 687 | |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 688 | if (!data || !fw_device_id_record || !applicable_components || |
| 689 | !comp_image_set_version_str || !record_descriptors || |
| 690 | !fw_device_pkg_data) { |
| 691 | return PLDM_ERROR_INVALID_DATA; |
| 692 | } |
| 693 | |
| 694 | header.component_bitmap_bit_length = component_bitmap_bit_length; |
| 695 | memcpy(header.package_header_identifier, PLDM_FWUP_HDR_IDENTIFIER_V1, |
| 696 | sizeof(PLDM_FWUP_HDR_IDENTIFIER_V1)); |
| 697 | header.package_header_format_revision = 1; |
| 698 | rc = decode_firmware_device_id_record_errno(data, length, &header, |
| 699 | &rec); |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 700 | if (rc < 0) { |
| 701 | return pldm_xlate_errno(rc); |
| 702 | } |
| 703 | |
Andrew Jeffery | bacbbac | 2025-03-12 04:02:18 +0000 | [diff] [blame^] | 704 | memcpy(&fw_device_id_record->record_length, data, |
| 705 | sizeof(fw_device_id_record->record_length)); |
| 706 | LE16TOH(fw_device_id_record->record_length); |
| 707 | fw_device_id_record->descriptor_count = rec.descriptor_count; |
| 708 | fw_device_id_record->device_update_option_flags = |
| 709 | rec.device_update_option_flags; |
| 710 | fw_device_id_record->comp_image_set_version_string_type = |
| 711 | rec.component_image_set_version_string_type; |
| 712 | fw_device_id_record->comp_image_set_version_string_length = |
| 713 | rec.component_image_set_version_string.length; |
| 714 | fw_device_id_record->fw_device_pkg_data_length = |
| 715 | rec.firmware_device_package_data.length; |
| 716 | *applicable_components = rec.applicable_components.bitmap; |
| 717 | *comp_image_set_version_str = rec.component_image_set_version_string; |
| 718 | *record_descriptors = rec.record_descriptors; |
| 719 | *fw_device_pkg_data = rec.firmware_device_package_data; |
| 720 | |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 721 | return PLDM_SUCCESS; |
| 722 | } |
| 723 | |
Unive Tien | e5c3f14 | 2024-12-13 14:14:19 +0800 | [diff] [blame] | 724 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 3a2c658 | 2024-11-07 16:30:36 +1030 | [diff] [blame] | 725 | int decode_pldm_descriptor_from_iter(struct pldm_descriptor_iter *iter, |
| 726 | struct pldm_descriptor *desc) |
| 727 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 728 | PLDM_MSGBUF_DEFINE_P(buf); |
Andrew Jeffery | 3a2c658 | 2024-11-07 16:30:36 +1030 | [diff] [blame] | 729 | int rc; |
| 730 | |
| 731 | if (!iter || !iter->field || !desc) { |
| 732 | return -EINVAL; |
| 733 | } |
| 734 | |
| 735 | rc = pldm_msgbuf_init_errno(buf, PLDM_FWUP_DEVICE_DESCRIPTOR_MIN_LEN, |
| 736 | iter->field->ptr, iter->field->length); |
| 737 | if (rc) { |
| 738 | return rc; |
| 739 | } |
| 740 | |
| 741 | pldm_msgbuf_extract(buf, desc->descriptor_type); |
| 742 | rc = pldm_msgbuf_extract(buf, desc->descriptor_length); |
| 743 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 744 | return pldm_msgbuf_discard(buf, rc); |
Andrew Jeffery | 3a2c658 | 2024-11-07 16:30:36 +1030 | [diff] [blame] | 745 | } |
| 746 | |
| 747 | desc->descriptor_data = NULL; |
| 748 | pldm_msgbuf_span_required(buf, desc->descriptor_length, |
| 749 | (void **)&desc->descriptor_data); |
| 750 | iter->field->ptr = NULL; |
| 751 | pldm_msgbuf_span_remaining(buf, (void **)&iter->field->ptr, |
| 752 | &iter->field->length); |
| 753 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 754 | return pldm_msgbuf_complete(buf); |
Andrew Jeffery | 3a2c658 | 2024-11-07 16:30:36 +1030 | [diff] [blame] | 755 | } |
| 756 | |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 757 | static int decode_descriptor_type_length_value_errno( |
Andrew Jeffery | 0ba6aa0 | 2025-03-06 11:22:37 +1030 | [diff] [blame] | 758 | const void *data, size_t length, uint16_t *descriptor_type, |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 759 | struct variable_field *descriptor_data) |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 760 | { |
| 761 | uint16_t descriptor_length = 0; |
| 762 | |
| 763 | if (data == NULL || descriptor_type == NULL || |
| 764 | descriptor_data == NULL) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 765 | return -EINVAL; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 766 | } |
| 767 | |
| 768 | if (length < PLDM_FWUP_DEVICE_DESCRIPTOR_MIN_LEN) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 769 | return -EOVERFLOW; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 770 | } |
| 771 | |
| 772 | struct pldm_descriptor_tlv *entry = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 773 | (struct pldm_descriptor_tlv *)(data); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 774 | |
| 775 | *descriptor_type = le16toh(entry->descriptor_type); |
| 776 | descriptor_length = le16toh(entry->descriptor_length); |
| 777 | if (*descriptor_type != PLDM_FWUP_VENDOR_DEFINED) { |
| 778 | if (descriptor_length != |
| 779 | get_descriptor_type_length(*descriptor_type)) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 780 | return -EBADMSG; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 781 | } |
| 782 | } |
| 783 | |
| 784 | if (length < (sizeof(*descriptor_type) + sizeof(descriptor_length) + |
| 785 | descriptor_length)) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 786 | return -EOVERFLOW; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 787 | } |
| 788 | |
| 789 | descriptor_data->ptr = entry->descriptor_data; |
| 790 | descriptor_data->length = descriptor_length; |
| 791 | |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 792 | return 0; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 793 | } |
| 794 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 795 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 796 | int decode_descriptor_type_length_value(const uint8_t *data, size_t length, |
| 797 | uint16_t *descriptor_type, |
| 798 | struct variable_field *descriptor_data) |
| 799 | { |
| 800 | int rc; |
| 801 | |
| 802 | rc = decode_descriptor_type_length_value_errno( |
| 803 | data, length, descriptor_type, descriptor_data); |
| 804 | if (rc < 0) { |
| 805 | return pldm_xlate_errno(rc); |
| 806 | } |
| 807 | |
| 808 | return PLDM_SUCCESS; |
| 809 | } |
| 810 | |
| 811 | static int decode_vendor_defined_descriptor_value_errno( |
Andrew Jeffery | 0ba6aa0 | 2025-03-06 11:22:37 +1030 | [diff] [blame] | 812 | const void *data, size_t length, uint8_t *descriptor_title_str_type, |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 813 | struct variable_field *descriptor_title_str, |
| 814 | struct variable_field *descriptor_data) |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 815 | { |
| 816 | if (data == NULL || descriptor_title_str_type == NULL || |
| 817 | descriptor_title_str == NULL || descriptor_data == NULL) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 818 | return -EINVAL; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 819 | } |
| 820 | |
| 821 | if (length < sizeof(struct pldm_vendor_defined_descriptor_title_data)) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 822 | return -EOVERFLOW; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 823 | } |
| 824 | |
| 825 | struct pldm_vendor_defined_descriptor_title_data *entry = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 826 | (struct pldm_vendor_defined_descriptor_title_data *)(data); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 827 | if (!is_string_type_valid( |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 828 | entry->vendor_defined_descriptor_title_str_type) || |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 829 | (entry->vendor_defined_descriptor_title_str_len == 0)) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 830 | return -EBADMSG; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 831 | } |
| 832 | |
Manojkiran Eda | 9e3a5d4 | 2024-06-17 16:06:42 +0530 | [diff] [blame] | 833 | // Assuming at least 1 byte of VendorDefinedDescriptorData |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 834 | if (length < (sizeof(struct pldm_vendor_defined_descriptor_title_data) + |
| 835 | entry->vendor_defined_descriptor_title_str_len)) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 836 | return -EOVERFLOW; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 837 | } |
| 838 | |
| 839 | *descriptor_title_str_type = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 840 | entry->vendor_defined_descriptor_title_str_type; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 841 | descriptor_title_str->ptr = entry->vendor_defined_descriptor_title_str; |
| 842 | descriptor_title_str->length = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 843 | entry->vendor_defined_descriptor_title_str_len; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 844 | |
| 845 | descriptor_data->ptr = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 846 | descriptor_title_str->ptr + descriptor_title_str->length; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 847 | descriptor_data->length = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 848 | length - |
| 849 | sizeof(entry->vendor_defined_descriptor_title_str_type) - |
| 850 | sizeof(entry->vendor_defined_descriptor_title_str_len) - |
| 851 | descriptor_title_str->length; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 852 | |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 853 | return 0; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 854 | } |
| 855 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 856 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 857 | int decode_vendor_defined_descriptor_value( |
| 858 | const uint8_t *data, size_t length, uint8_t *descriptor_title_str_type, |
| 859 | struct variable_field *descriptor_title_str, |
| 860 | struct variable_field *descriptor_data) |
| 861 | { |
| 862 | int rc; |
| 863 | |
| 864 | rc = decode_vendor_defined_descriptor_value_errno( |
| 865 | data, length, descriptor_title_str_type, descriptor_title_str, |
| 866 | descriptor_data); |
| 867 | if (rc < 0) { |
| 868 | return pldm_xlate_errno(rc); |
| 869 | } |
| 870 | |
| 871 | return PLDM_SUCCESS; |
| 872 | } |
| 873 | |
| 874 | static int decode_pldm_comp_image_info_errno( |
Andrew Jeffery | 0ba6aa0 | 2025-03-06 11:22:37 +1030 | [diff] [blame] | 875 | const void *data, size_t length, |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 876 | struct pldm_component_image_information *pldm_comp_image_info, |
| 877 | struct variable_field *comp_version_str) |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 878 | { |
| 879 | if (data == NULL || pldm_comp_image_info == NULL || |
| 880 | comp_version_str == NULL) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 881 | return -EINVAL; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 882 | } |
| 883 | |
| 884 | if (length < sizeof(struct pldm_component_image_information)) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 885 | return -EOVERFLOW; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 886 | } |
| 887 | |
| 888 | struct pldm_component_image_information *data_header = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 889 | (struct pldm_component_image_information *)(data); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 890 | |
| 891 | if (!is_string_type_valid(data_header->comp_version_string_type) || |
| 892 | (data_header->comp_version_string_length == 0)) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 893 | return -EBADMSG; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 894 | } |
| 895 | |
| 896 | if (length < sizeof(struct pldm_component_image_information) + |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 897 | data_header->comp_version_string_length) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 898 | return -EOVERFLOW; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 899 | } |
| 900 | |
| 901 | pldm_comp_image_info->comp_classification = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 902 | le16toh(data_header->comp_classification); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 903 | pldm_comp_image_info->comp_identifier = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 904 | le16toh(data_header->comp_identifier); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 905 | pldm_comp_image_info->comp_comparison_stamp = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 906 | le32toh(data_header->comp_comparison_stamp); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 907 | pldm_comp_image_info->comp_options.value = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 908 | le16toh(data_header->comp_options.value); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 909 | pldm_comp_image_info->requested_comp_activation_method.value = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 910 | le16toh(data_header->requested_comp_activation_method.value); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 911 | pldm_comp_image_info->comp_location_offset = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 912 | le32toh(data_header->comp_location_offset); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 913 | pldm_comp_image_info->comp_size = le32toh(data_header->comp_size); |
| 914 | pldm_comp_image_info->comp_version_string_type = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 915 | data_header->comp_version_string_type; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 916 | pldm_comp_image_info->comp_version_string_length = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 917 | data_header->comp_version_string_length; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 918 | |
| 919 | if ((pldm_comp_image_info->comp_options.bits.bit1 == false && |
| 920 | pldm_comp_image_info->comp_comparison_stamp != |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 921 | PLDM_FWUP_INVALID_COMPONENT_COMPARISON_TIMESTAMP)) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 922 | return -EBADMSG; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 923 | } |
| 924 | |
| 925 | if (pldm_comp_image_info->comp_location_offset == 0 || |
| 926 | pldm_comp_image_info->comp_size == 0) { |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 927 | return -EBADMSG; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 928 | } |
| 929 | |
Andrew Jeffery | 0ba6aa0 | 2025-03-06 11:22:37 +1030 | [diff] [blame] | 930 | comp_version_str->ptr = (const uint8_t *)data + |
| 931 | sizeof(struct pldm_component_image_information); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 932 | comp_version_str->length = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 933 | pldm_comp_image_info->comp_version_string_length; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 934 | |
Andrew Jeffery | 779e9db | 2025-02-21 12:14:28 +1030 | [diff] [blame] | 935 | return 0; |
| 936 | } |
| 937 | |
| 938 | LIBPLDM_ABI_STABLE |
| 939 | int decode_pldm_comp_image_info( |
| 940 | const uint8_t *data, size_t length, |
| 941 | struct pldm_component_image_information *pldm_comp_image_info, |
| 942 | struct variable_field *comp_version_str) |
| 943 | { |
| 944 | int rc; |
| 945 | |
| 946 | rc = decode_pldm_comp_image_info_errno( |
| 947 | data, length, pldm_comp_image_info, comp_version_str); |
| 948 | if (rc < 0) { |
| 949 | return pldm_xlate_errno(rc); |
| 950 | } |
| 951 | |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 952 | return PLDM_SUCCESS; |
| 953 | } |
| 954 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 955 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 956 | int encode_query_device_identifiers_req(uint8_t instance_id, |
| 957 | size_t payload_length, |
| 958 | struct pldm_msg *msg) |
| 959 | { |
| 960 | if (msg == NULL) { |
| 961 | return PLDM_ERROR_INVALID_DATA; |
| 962 | } |
| 963 | |
| 964 | if (payload_length != PLDM_QUERY_DEVICE_IDENTIFIERS_REQ_BYTES) { |
| 965 | return PLDM_ERROR_INVALID_LENGTH; |
| 966 | } |
| 967 | |
| 968 | return encode_pldm_header_only(PLDM_REQUEST, instance_id, PLDM_FWUP, |
| 969 | PLDM_QUERY_DEVICE_IDENTIFIERS, msg); |
| 970 | } |
| 971 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 972 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 973 | int decode_query_device_identifiers_resp(const struct pldm_msg *msg, |
| 974 | size_t payload_length, |
| 975 | uint8_t *completion_code, |
| 976 | uint32_t *device_identifiers_len, |
| 977 | uint8_t *descriptor_count, |
| 978 | uint8_t **descriptor_data) |
| 979 | { |
| 980 | if (msg == NULL || completion_code == NULL || |
| 981 | device_identifiers_len == NULL || descriptor_count == NULL || |
| 982 | descriptor_data == NULL) { |
| 983 | return PLDM_ERROR_INVALID_DATA; |
| 984 | } |
| 985 | |
| 986 | *completion_code = msg->payload[0]; |
| 987 | if (PLDM_SUCCESS != *completion_code) { |
| 988 | return PLDM_SUCCESS; |
| 989 | } |
| 990 | |
| 991 | if (payload_length < |
| 992 | sizeof(struct pldm_query_device_identifiers_resp)) { |
| 993 | return PLDM_ERROR_INVALID_LENGTH; |
| 994 | } |
| 995 | |
| 996 | struct pldm_query_device_identifiers_resp *response = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 997 | (struct pldm_query_device_identifiers_resp *)msg->payload; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 998 | *device_identifiers_len = le32toh(response->device_identifiers_len); |
| 999 | |
| 1000 | if (*device_identifiers_len < PLDM_FWUP_DEVICE_DESCRIPTOR_MIN_LEN) { |
| 1001 | return PLDM_ERROR_INVALID_LENGTH; |
| 1002 | } |
| 1003 | |
| 1004 | if (payload_length != |
| 1005 | sizeof(struct pldm_query_device_identifiers_resp) + |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1006 | *device_identifiers_len) { |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1007 | return PLDM_ERROR_INVALID_LENGTH; |
| 1008 | } |
| 1009 | *descriptor_count = response->descriptor_count; |
| 1010 | |
| 1011 | if (*descriptor_count == 0) { |
| 1012 | return PLDM_ERROR_INVALID_DATA; |
| 1013 | } |
| 1014 | *descriptor_data = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1015 | (uint8_t *)(msg->payload + |
| 1016 | sizeof(struct pldm_query_device_identifiers_resp)); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1017 | return PLDM_SUCCESS; |
| 1018 | } |
| 1019 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1020 | LIBPLDM_ABI_TESTING |
| 1021 | int encode_query_device_identifiers_resp( |
| 1022 | uint8_t instance_id, uint8_t descriptor_count, |
| 1023 | const struct pldm_descriptor *descriptors, struct pldm_msg *msg, |
| 1024 | size_t *payload_length) |
| 1025 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1026 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1027 | int rc; |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1028 | |
| 1029 | if (descriptors == NULL || msg == NULL || payload_length == NULL) { |
| 1030 | return -EINVAL; |
| 1031 | } |
| 1032 | |
| 1033 | if (descriptor_count < 1) { |
| 1034 | return -EINVAL; |
| 1035 | } |
| 1036 | |
| 1037 | rc = encode_pldm_header_only(PLDM_RESPONSE, instance_id, PLDM_FWUP, |
| 1038 | PLDM_QUERY_DEVICE_IDENTIFIERS, msg); |
| 1039 | if (rc) { |
| 1040 | return -EINVAL; |
| 1041 | } |
| 1042 | |
| 1043 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, *payload_length); |
| 1044 | if (rc) { |
| 1045 | return rc; |
| 1046 | } |
| 1047 | |
| 1048 | /* Determine total length */ |
| 1049 | uint32_t device_identifiers_len = 0; |
| 1050 | for (uint8_t i = 0; i < descriptor_count; i++) { |
| 1051 | const struct pldm_descriptor *d = &descriptors[i]; |
| 1052 | device_identifiers_len += |
| 1053 | 2 * sizeof(uint16_t) + d->descriptor_length; |
| 1054 | } |
| 1055 | |
| 1056 | pldm_msgbuf_insert_uint8(buf, PLDM_SUCCESS); |
| 1057 | pldm_msgbuf_insert(buf, device_identifiers_len); |
| 1058 | pldm_msgbuf_insert(buf, descriptor_count); |
| 1059 | |
| 1060 | for (uint8_t i = 0; i < descriptor_count; i++) { |
| 1061 | const struct pldm_descriptor *d = &descriptors[i]; |
| 1062 | pldm_msgbuf_insert(buf, d->descriptor_type); |
| 1063 | pldm_msgbuf_insert(buf, d->descriptor_length); |
| 1064 | if (d->descriptor_data == NULL) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1065 | return pldm_msgbuf_discard(buf, -EINVAL); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1066 | } |
| 1067 | rc = pldm_msgbuf_insert_array( |
| 1068 | buf, d->descriptor_length, |
| 1069 | (const uint8_t *)d->descriptor_data, |
| 1070 | d->descriptor_length); |
| 1071 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1072 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1073 | } |
| 1074 | } |
| 1075 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 1076 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1077 | } |
| 1078 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 1079 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1080 | int encode_get_firmware_parameters_req(uint8_t instance_id, |
| 1081 | size_t payload_length, |
| 1082 | struct pldm_msg *msg) |
| 1083 | { |
| 1084 | if (msg == NULL) { |
| 1085 | return PLDM_ERROR_INVALID_DATA; |
| 1086 | } |
| 1087 | |
| 1088 | if (payload_length != PLDM_GET_FIRMWARE_PARAMETERS_REQ_BYTES) { |
| 1089 | return PLDM_ERROR_INVALID_LENGTH; |
| 1090 | } |
| 1091 | |
| 1092 | return encode_pldm_header_only(PLDM_REQUEST, instance_id, PLDM_FWUP, |
| 1093 | PLDM_GET_FIRMWARE_PARAMETERS, msg); |
| 1094 | } |
| 1095 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 1096 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1097 | int decode_get_firmware_parameters_resp( |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1098 | const struct pldm_msg *msg, size_t payload_length, |
| 1099 | struct pldm_get_firmware_parameters_resp *resp_data, |
| 1100 | struct variable_field *active_comp_image_set_ver_str, |
| 1101 | struct variable_field *pending_comp_image_set_ver_str, |
| 1102 | struct variable_field *comp_parameter_table) |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1103 | { |
| 1104 | if (msg == NULL || resp_data == NULL || |
| 1105 | active_comp_image_set_ver_str == NULL || |
| 1106 | pending_comp_image_set_ver_str == NULL || |
| 1107 | comp_parameter_table == NULL || !payload_length) { |
| 1108 | return PLDM_ERROR_INVALID_DATA; |
| 1109 | } |
| 1110 | |
| 1111 | resp_data->completion_code = msg->payload[0]; |
| 1112 | if (PLDM_SUCCESS != resp_data->completion_code) { |
| 1113 | return PLDM_SUCCESS; |
| 1114 | } |
| 1115 | |
| 1116 | if (payload_length < sizeof(struct pldm_get_firmware_parameters_resp)) { |
| 1117 | return PLDM_ERROR_INVALID_LENGTH; |
| 1118 | } |
| 1119 | |
| 1120 | struct pldm_get_firmware_parameters_resp *response = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1121 | (struct pldm_get_firmware_parameters_resp *)msg->payload; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1122 | |
| 1123 | if (!is_string_type_valid( |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1124 | response->active_comp_image_set_ver_str_type) || |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1125 | (response->active_comp_image_set_ver_str_len == 0)) { |
| 1126 | return PLDM_ERROR_INVALID_DATA; |
| 1127 | } |
| 1128 | |
| 1129 | if (response->pending_comp_image_set_ver_str_len == 0) { |
| 1130 | if (response->pending_comp_image_set_ver_str_type != |
| 1131 | PLDM_STR_TYPE_UNKNOWN) { |
| 1132 | return PLDM_ERROR_INVALID_DATA; |
| 1133 | } |
| 1134 | } else { |
| 1135 | if (!is_string_type_valid( |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1136 | response->pending_comp_image_set_ver_str_type)) { |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1137 | return PLDM_ERROR_INVALID_DATA; |
| 1138 | } |
| 1139 | } |
| 1140 | |
| 1141 | size_t partial_response_length = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1142 | sizeof(struct pldm_get_firmware_parameters_resp) + |
| 1143 | response->active_comp_image_set_ver_str_len + |
| 1144 | response->pending_comp_image_set_ver_str_len; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1145 | |
| 1146 | if (payload_length < partial_response_length) { |
| 1147 | return PLDM_ERROR_INVALID_LENGTH; |
| 1148 | } |
| 1149 | |
| 1150 | resp_data->capabilities_during_update.value = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1151 | le32toh(response->capabilities_during_update.value); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1152 | resp_data->comp_count = le16toh(response->comp_count); |
| 1153 | resp_data->active_comp_image_set_ver_str_type = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1154 | response->active_comp_image_set_ver_str_type; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1155 | resp_data->active_comp_image_set_ver_str_len = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1156 | response->active_comp_image_set_ver_str_len; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1157 | resp_data->pending_comp_image_set_ver_str_type = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1158 | response->pending_comp_image_set_ver_str_type; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1159 | resp_data->pending_comp_image_set_ver_str_len = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1160 | response->pending_comp_image_set_ver_str_len; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1161 | |
| 1162 | active_comp_image_set_ver_str->ptr = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1163 | msg->payload + sizeof(struct pldm_get_firmware_parameters_resp); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1164 | active_comp_image_set_ver_str->length = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1165 | resp_data->active_comp_image_set_ver_str_len; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1166 | |
| 1167 | if (resp_data->pending_comp_image_set_ver_str_len != 0) { |
| 1168 | pending_comp_image_set_ver_str->ptr = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1169 | msg->payload + |
| 1170 | sizeof(struct pldm_get_firmware_parameters_resp) + |
| 1171 | resp_data->active_comp_image_set_ver_str_len; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1172 | pending_comp_image_set_ver_str->length = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1173 | resp_data->pending_comp_image_set_ver_str_len; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1174 | } else { |
| 1175 | pending_comp_image_set_ver_str->ptr = NULL; |
| 1176 | pending_comp_image_set_ver_str->length = 0; |
| 1177 | } |
| 1178 | |
| 1179 | if (payload_length > partial_response_length && resp_data->comp_count) { |
| 1180 | comp_parameter_table->ptr = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1181 | msg->payload + |
| 1182 | sizeof(struct pldm_get_firmware_parameters_resp) + |
| 1183 | resp_data->active_comp_image_set_ver_str_len + |
| 1184 | resp_data->pending_comp_image_set_ver_str_len; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1185 | comp_parameter_table->length = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1186 | payload_length - partial_response_length; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1187 | } else { |
| 1188 | comp_parameter_table->ptr = NULL; |
| 1189 | comp_parameter_table->length = 0; |
| 1190 | } |
| 1191 | |
| 1192 | return PLDM_SUCCESS; |
| 1193 | } |
| 1194 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1195 | LIBPLDM_ABI_TESTING |
| 1196 | int encode_get_firmware_parameters_resp( |
| 1197 | uint8_t instance_id, |
| 1198 | const struct pldm_get_firmware_parameters_resp_full *resp_data, |
| 1199 | struct pldm_msg *msg, size_t *payload_length) |
| 1200 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1201 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1202 | int rc; |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1203 | |
| 1204 | if (resp_data == NULL || msg == NULL || payload_length == NULL) { |
| 1205 | return -EINVAL; |
| 1206 | } |
| 1207 | |
| 1208 | rc = encode_pldm_header_only(PLDM_RESPONSE, instance_id, PLDM_FWUP, |
| 1209 | PLDM_GET_FIRMWARE_PARAMETERS, msg); |
| 1210 | if (rc) { |
| 1211 | return -EINVAL; |
| 1212 | } |
| 1213 | |
| 1214 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, *payload_length); |
| 1215 | if (rc) { |
| 1216 | return rc; |
| 1217 | } |
| 1218 | |
| 1219 | pldm_msgbuf_insert(buf, resp_data->completion_code); |
| 1220 | pldm_msgbuf_insert(buf, resp_data->capabilities_during_update.value); |
| 1221 | pldm_msgbuf_insert(buf, resp_data->comp_count); |
| 1222 | pldm_msgbuf_insert(buf, |
| 1223 | resp_data->active_comp_image_set_ver_str.str_type); |
| 1224 | pldm_msgbuf_insert(buf, |
| 1225 | resp_data->active_comp_image_set_ver_str.str_len); |
| 1226 | pldm_msgbuf_insert(buf, |
| 1227 | resp_data->pending_comp_image_set_ver_str.str_type); |
| 1228 | pldm_msgbuf_insert(buf, |
| 1229 | resp_data->pending_comp_image_set_ver_str.str_len); |
| 1230 | /* String data appended */ |
| 1231 | rc = pldm_msgbuf_insert_array( |
| 1232 | buf, resp_data->active_comp_image_set_ver_str.str_len, |
| 1233 | resp_data->active_comp_image_set_ver_str.str_data, |
| 1234 | resp_data->active_comp_image_set_ver_str.str_len); |
| 1235 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1236 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1237 | } |
| 1238 | rc = pldm_msgbuf_insert_array( |
| 1239 | buf, resp_data->pending_comp_image_set_ver_str.str_len, |
| 1240 | resp_data->pending_comp_image_set_ver_str.str_data, |
| 1241 | resp_data->pending_comp_image_set_ver_str.str_len); |
| 1242 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1243 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1244 | } |
| 1245 | |
| 1246 | /* Further calls to encode_get_firmware_parameters_resp_comp_entry |
| 1247 | * will populate the remainder */ |
| 1248 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 1249 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1250 | } |
| 1251 | |
| 1252 | LIBPLDM_ABI_TESTING |
| 1253 | int encode_get_firmware_parameters_resp_comp_entry( |
| 1254 | const struct pldm_component_parameter_entry_full *comp, |
| 1255 | uint8_t *payload, size_t *payload_length) |
| 1256 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1257 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1258 | int rc; |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1259 | |
| 1260 | if (comp == NULL || payload == NULL || payload_length == NULL) { |
| 1261 | return -EINVAL; |
| 1262 | } |
| 1263 | |
| 1264 | rc = pldm_msgbuf_init_errno(buf, 0, payload, *payload_length); |
| 1265 | if (rc) { |
| 1266 | return rc; |
| 1267 | } |
| 1268 | |
| 1269 | pldm_msgbuf_insert(buf, comp->comp_classification); |
| 1270 | pldm_msgbuf_insert(buf, comp->comp_identifier); |
| 1271 | pldm_msgbuf_insert(buf, comp->comp_classification_index); |
| 1272 | |
| 1273 | pldm_msgbuf_insert(buf, comp->active_ver.comparison_stamp); |
| 1274 | pldm_msgbuf_insert(buf, (uint8_t)comp->active_ver.str.str_type); |
| 1275 | pldm_msgbuf_insert(buf, comp->active_ver.str.str_len); |
| 1276 | rc = pldm_msgbuf_insert_array(buf, PLDM_FWUP_COMPONENT_RELEASE_DATA_LEN, |
| 1277 | comp->active_ver.date, |
| 1278 | PLDM_FWUP_COMPONENT_RELEASE_DATA_LEN); |
| 1279 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1280 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1281 | } |
| 1282 | |
| 1283 | pldm_msgbuf_insert(buf, comp->pending_ver.comparison_stamp); |
| 1284 | pldm_msgbuf_insert(buf, (uint8_t)comp->pending_ver.str.str_type); |
| 1285 | pldm_msgbuf_insert(buf, comp->pending_ver.str.str_len); |
| 1286 | rc = pldm_msgbuf_insert_array(buf, PLDM_FWUP_COMPONENT_RELEASE_DATA_LEN, |
| 1287 | comp->pending_ver.date, |
| 1288 | PLDM_FWUP_COMPONENT_RELEASE_DATA_LEN); |
| 1289 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1290 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1291 | } |
| 1292 | |
| 1293 | pldm_msgbuf_insert(buf, comp->comp_activation_methods.value); |
| 1294 | pldm_msgbuf_insert(buf, comp->capabilities_during_update.value); |
| 1295 | |
| 1296 | rc = pldm_msgbuf_insert_array(buf, comp->active_ver.str.str_len, |
| 1297 | comp->active_ver.str.str_data, |
| 1298 | comp->active_ver.str.str_len); |
| 1299 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1300 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1301 | } |
| 1302 | rc = pldm_msgbuf_insert_array(buf, comp->pending_ver.str.str_len, |
| 1303 | comp->pending_ver.str.str_data, |
| 1304 | comp->pending_ver.str.str_len); |
| 1305 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1306 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1307 | } |
| 1308 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 1309 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1310 | } |
| 1311 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 1312 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1313 | int decode_get_firmware_parameters_resp_comp_entry( |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1314 | const uint8_t *data, size_t length, |
| 1315 | struct pldm_component_parameter_entry *component_data, |
| 1316 | struct variable_field *active_comp_ver_str, |
| 1317 | struct variable_field *pending_comp_ver_str) |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1318 | { |
| 1319 | if (data == NULL || component_data == NULL || |
| 1320 | active_comp_ver_str == NULL || pending_comp_ver_str == NULL) { |
| 1321 | return PLDM_ERROR_INVALID_DATA; |
| 1322 | } |
| 1323 | |
| 1324 | if (length < sizeof(struct pldm_component_parameter_entry)) { |
| 1325 | return PLDM_ERROR_INVALID_LENGTH; |
| 1326 | } |
| 1327 | |
| 1328 | struct pldm_component_parameter_entry *entry = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1329 | (struct pldm_component_parameter_entry *)(data); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1330 | |
| 1331 | size_t entry_length = sizeof(struct pldm_component_parameter_entry) + |
| 1332 | entry->active_comp_ver_str_len + |
| 1333 | entry->pending_comp_ver_str_len; |
| 1334 | |
| 1335 | if (length < entry_length) { |
| 1336 | return PLDM_ERROR_INVALID_LENGTH; |
| 1337 | } |
| 1338 | |
| 1339 | component_data->comp_classification = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1340 | le16toh(entry->comp_classification); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1341 | component_data->comp_identifier = le16toh(entry->comp_identifier); |
| 1342 | component_data->comp_classification_index = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1343 | entry->comp_classification_index; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1344 | component_data->active_comp_comparison_stamp = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1345 | le32toh(entry->active_comp_comparison_stamp); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1346 | component_data->active_comp_ver_str_type = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1347 | entry->active_comp_ver_str_type; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1348 | component_data->active_comp_ver_str_len = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1349 | entry->active_comp_ver_str_len; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1350 | memcpy(component_data->active_comp_release_date, |
| 1351 | entry->active_comp_release_date, |
| 1352 | sizeof(entry->active_comp_release_date)); |
| 1353 | component_data->pending_comp_comparison_stamp = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1354 | le32toh(entry->pending_comp_comparison_stamp); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1355 | component_data->pending_comp_ver_str_type = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1356 | entry->pending_comp_ver_str_type; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1357 | component_data->pending_comp_ver_str_len = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1358 | entry->pending_comp_ver_str_len; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1359 | memcpy(component_data->pending_comp_release_date, |
| 1360 | entry->pending_comp_release_date, |
| 1361 | sizeof(entry->pending_comp_release_date)); |
| 1362 | component_data->comp_activation_methods.value = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1363 | le16toh(entry->comp_activation_methods.value); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1364 | component_data->capabilities_during_update.value = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1365 | le32toh(entry->capabilities_during_update.value); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1366 | |
| 1367 | if (entry->active_comp_ver_str_len != 0) { |
| 1368 | active_comp_ver_str->ptr = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1369 | data + sizeof(struct pldm_component_parameter_entry); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1370 | active_comp_ver_str->length = entry->active_comp_ver_str_len; |
| 1371 | } else { |
| 1372 | active_comp_ver_str->ptr = NULL; |
| 1373 | active_comp_ver_str->length = 0; |
| 1374 | } |
| 1375 | |
| 1376 | if (entry->pending_comp_ver_str_len != 0) { |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1377 | pending_comp_ver_str->ptr = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1378 | data + sizeof(struct pldm_component_parameter_entry) + |
| 1379 | entry->active_comp_ver_str_len; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1380 | pending_comp_ver_str->length = entry->pending_comp_ver_str_len; |
| 1381 | } else { |
| 1382 | pending_comp_ver_str->ptr = NULL; |
| 1383 | pending_comp_ver_str->length = 0; |
| 1384 | } |
| 1385 | return PLDM_SUCCESS; |
| 1386 | } |
| 1387 | |
Unive Tien | e5c3f14 | 2024-12-13 14:14:19 +0800 | [diff] [blame] | 1388 | LIBPLDM_ABI_STABLE |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 1389 | int encode_query_downstream_devices_req(uint8_t instance_id, |
| 1390 | struct pldm_msg *msg) |
| 1391 | { |
| 1392 | if (msg == NULL) { |
Unive Tien | 71e935c | 2024-11-25 17:21:43 +0800 | [diff] [blame] | 1393 | return -EINVAL; |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 1394 | } |
| 1395 | |
Unive Tien | 71e935c | 2024-11-25 17:21:43 +0800 | [diff] [blame] | 1396 | return encode_pldm_header_only_errno(PLDM_REQUEST, instance_id, |
| 1397 | PLDM_FWUP, |
| 1398 | PLDM_QUERY_DOWNSTREAM_DEVICES, |
| 1399 | msg); |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 1400 | } |
| 1401 | |
Unive Tien | e5c3f14 | 2024-12-13 14:14:19 +0800 | [diff] [blame] | 1402 | LIBPLDM_ABI_STABLE |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 1403 | int decode_query_downstream_devices_resp( |
| 1404 | const struct pldm_msg *msg, size_t payload_length, |
| 1405 | struct pldm_query_downstream_devices_resp *resp_data) |
| 1406 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1407 | PLDM_MSGBUF_DEFINE_P(buf); |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 1408 | int rc; |
| 1409 | |
| 1410 | if (msg == NULL || resp_data == NULL || !payload_length) { |
Unive Tien | 71e935c | 2024-11-25 17:21:43 +0800 | [diff] [blame] | 1411 | return -EINVAL; |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 1412 | } |
| 1413 | |
Andrew Jeffery | 830c1eb | 2024-10-04 10:48:10 +0930 | [diff] [blame] | 1414 | rc = pldm_msgbuf_init_errno(buf, PLDM_OPTIONAL_COMMAND_RESP_MIN_LEN, |
| 1415 | msg->payload, payload_length); |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 1416 | if (rc) { |
| 1417 | return rc; |
| 1418 | } |
| 1419 | |
| 1420 | rc = pldm_msgbuf_extract(buf, resp_data->completion_code); |
| 1421 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1422 | return pldm_msgbuf_discard(buf, rc); |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 1423 | } |
| 1424 | if (PLDM_SUCCESS != resp_data->completion_code) { |
| 1425 | // Return the CC directly without decoding the rest of the payload |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1426 | return pldm_msgbuf_complete(buf); |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 1427 | } |
| 1428 | |
| 1429 | if (payload_length < PLDM_QUERY_DOWNSTREAM_DEVICES_RESP_BYTES) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1430 | return pldm_msgbuf_discard(buf, -EBADMSG); |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 1431 | } |
| 1432 | |
| 1433 | rc = pldm_msgbuf_extract(buf, |
| 1434 | resp_data->downstream_device_update_supported); |
| 1435 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1436 | return pldm_msgbuf_discard(buf, rc); |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 1437 | } |
| 1438 | |
| 1439 | if (!is_downstream_device_update_support_valid( |
| 1440 | resp_data->downstream_device_update_supported)) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1441 | return pldm_msgbuf_discard(buf, -EINVAL); |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 1442 | } |
| 1443 | |
| 1444 | pldm_msgbuf_extract(buf, resp_data->number_of_downstream_devices); |
| 1445 | pldm_msgbuf_extract(buf, resp_data->max_number_of_downstream_devices); |
| 1446 | pldm_msgbuf_extract(buf, resp_data->capabilities.value); |
| 1447 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 1448 | return pldm_msgbuf_complete_consumed(buf); |
Chris Wang | 4c1f2c7 | 2024-03-21 17:09:44 +0800 | [diff] [blame] | 1449 | } |
| 1450 | |
Unive Tien | e5c3f14 | 2024-12-13 14:14:19 +0800 | [diff] [blame] | 1451 | LIBPLDM_ABI_STABLE |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1452 | int encode_query_downstream_identifiers_req( |
Unive Tien | d2f8a7e | 2024-11-27 10:59:34 +0800 | [diff] [blame] | 1453 | uint8_t instance_id, |
| 1454 | const struct pldm_query_downstream_identifiers_req *params_req, |
| 1455 | struct pldm_msg *msg, size_t payload_length) |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1456 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1457 | PLDM_MSGBUF_DEFINE_P(buf); |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1458 | int rc; |
| 1459 | |
Unive Tien | d2f8a7e | 2024-11-27 10:59:34 +0800 | [diff] [blame] | 1460 | if (!msg || !params_req) { |
Unive Tien | 71e935c | 2024-11-25 17:21:43 +0800 | [diff] [blame] | 1461 | return -EINVAL; |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1462 | } |
| 1463 | |
Unive Tien | d2f8a7e | 2024-11-27 10:59:34 +0800 | [diff] [blame] | 1464 | if (!is_transfer_operation_flag_valid( |
| 1465 | (enum transfer_op_flag) |
| 1466 | params_req->transfer_operation_flag)) { |
Unive Tien | 71e935c | 2024-11-25 17:21:43 +0800 | [diff] [blame] | 1467 | return -EINVAL; |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1468 | } |
| 1469 | |
| 1470 | struct pldm_header_info header = { 0 }; |
| 1471 | header.instance = instance_id; |
| 1472 | header.msg_type = PLDM_REQUEST; |
| 1473 | header.pldm_type = PLDM_FWUP; |
| 1474 | header.command = PLDM_QUERY_DOWNSTREAM_IDENTIFIERS; |
Unive Tien | 71e935c | 2024-11-25 17:21:43 +0800 | [diff] [blame] | 1475 | rc = pack_pldm_header_errno(&header, &(msg->hdr)); |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1476 | if (rc) { |
| 1477 | return rc; |
| 1478 | } |
| 1479 | |
Andrew Jeffery | 830c1eb | 2024-10-04 10:48:10 +0930 | [diff] [blame] | 1480 | rc = pldm_msgbuf_init_errno(buf, |
| 1481 | PLDM_QUERY_DOWNSTREAM_IDENTIFIERS_REQ_BYTES, |
| 1482 | msg->payload, payload_length); |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1483 | if (rc) { |
Unive Tien | 71e935c | 2024-11-25 17:21:43 +0800 | [diff] [blame] | 1484 | return rc; |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1485 | } |
| 1486 | |
Unive Tien | d2f8a7e | 2024-11-27 10:59:34 +0800 | [diff] [blame] | 1487 | pldm_msgbuf_insert(buf, params_req->data_transfer_handle); |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1488 | // Data correctness has been verified, cast it to 1-byte data directly. |
Unive Tien | d2f8a7e | 2024-11-27 10:59:34 +0800 | [diff] [blame] | 1489 | pldm_msgbuf_insert(buf, params_req->transfer_operation_flag); |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1490 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 1491 | return pldm_msgbuf_complete(buf); |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1492 | } |
| 1493 | |
Unive Tien | e5c3f14 | 2024-12-13 14:14:19 +0800 | [diff] [blame] | 1494 | LIBPLDM_ABI_STABLE |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1495 | int decode_query_downstream_identifiers_resp( |
| 1496 | const struct pldm_msg *msg, size_t payload_length, |
| 1497 | struct pldm_query_downstream_identifiers_resp *resp_data, |
Andrew Jeffery | 3a2c658 | 2024-11-07 16:30:36 +1030 | [diff] [blame] | 1498 | struct pldm_downstream_device_iter *iter) |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1499 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1500 | PLDM_MSGBUF_DEFINE_P(buf); |
Andrew Jeffery | 3a2c658 | 2024-11-07 16:30:36 +1030 | [diff] [blame] | 1501 | void *remaining = NULL; |
Unive Tien | 71e935c | 2024-11-25 17:21:43 +0800 | [diff] [blame] | 1502 | int rc = 0; |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1503 | |
Andrew Jeffery | 3a2c658 | 2024-11-07 16:30:36 +1030 | [diff] [blame] | 1504 | if (msg == NULL || resp_data == NULL || iter == NULL || |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1505 | !payload_length) { |
Unive Tien | 71e935c | 2024-11-25 17:21:43 +0800 | [diff] [blame] | 1506 | return -EINVAL; |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1507 | } |
| 1508 | |
Andrew Jeffery | 830c1eb | 2024-10-04 10:48:10 +0930 | [diff] [blame] | 1509 | rc = pldm_msgbuf_init_errno(buf, PLDM_OPTIONAL_COMMAND_RESP_MIN_LEN, |
| 1510 | msg->payload, payload_length); |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1511 | if (rc) { |
Unive Tien | 71e935c | 2024-11-25 17:21:43 +0800 | [diff] [blame] | 1512 | return rc; |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1513 | } |
| 1514 | |
| 1515 | rc = pldm_msgbuf_extract(buf, resp_data->completion_code); |
| 1516 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1517 | return pldm_msgbuf_discard(buf, rc); |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1518 | } |
| 1519 | if (PLDM_SUCCESS != resp_data->completion_code) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1520 | return pldm_msgbuf_complete(buf); |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1521 | } |
| 1522 | |
| 1523 | if (payload_length < PLDM_QUERY_DOWNSTREAM_IDENTIFIERS_RESP_MIN_LEN) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1524 | return pldm_msgbuf_discard(buf, -EBADMSG); |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1525 | } |
| 1526 | |
| 1527 | pldm_msgbuf_extract(buf, resp_data->next_data_transfer_handle); |
| 1528 | pldm_msgbuf_extract(buf, resp_data->transfer_flag); |
| 1529 | |
| 1530 | rc = pldm_msgbuf_extract(buf, resp_data->downstream_devices_length); |
| 1531 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1532 | return pldm_msgbuf_discard(buf, rc); |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1533 | } |
| 1534 | |
| 1535 | pldm_msgbuf_extract(buf, resp_data->number_of_downstream_devices); |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1536 | pldm_msgbuf_span_required(buf, resp_data->downstream_devices_length, |
| 1537 | &remaining); |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1538 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 1539 | rc = pldm_msgbuf_complete(buf); |
Andrew Jeffery | 830c1eb | 2024-10-04 10:48:10 +0930 | [diff] [blame] | 1540 | if (rc) { |
Unive Tien | 71e935c | 2024-11-25 17:21:43 +0800 | [diff] [blame] | 1541 | return rc; |
Andrew Jeffery | 830c1eb | 2024-10-04 10:48:10 +0930 | [diff] [blame] | 1542 | } |
| 1543 | |
Andrew Jeffery | 3a2c658 | 2024-11-07 16:30:36 +1030 | [diff] [blame] | 1544 | iter->field.ptr = remaining; |
| 1545 | iter->field.length = resp_data->downstream_devices_length; |
| 1546 | iter->devs = resp_data->number_of_downstream_devices; |
| 1547 | |
Unive Tien | 71e935c | 2024-11-25 17:21:43 +0800 | [diff] [blame] | 1548 | return 0; |
Chris Wang | 458475a | 2024-03-26 17:59:19 +0800 | [diff] [blame] | 1549 | } |
| 1550 | |
Unive Tien | e5c3f14 | 2024-12-13 14:14:19 +0800 | [diff] [blame] | 1551 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 3a2c658 | 2024-11-07 16:30:36 +1030 | [diff] [blame] | 1552 | int decode_pldm_downstream_device_from_iter( |
| 1553 | struct pldm_downstream_device_iter *iter, |
| 1554 | struct pldm_downstream_device *dev) |
| 1555 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1556 | PLDM_MSGBUF_DEFINE_P(buf); |
Andrew Jeffery | 3a2c658 | 2024-11-07 16:30:36 +1030 | [diff] [blame] | 1557 | int rc; |
| 1558 | |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1559 | if (!iter || !iter->field.ptr || !dev) { |
Andrew Jeffery | 3a2c658 | 2024-11-07 16:30:36 +1030 | [diff] [blame] | 1560 | return -EINVAL; |
| 1561 | } |
| 1562 | |
| 1563 | rc = pldm_msgbuf_init_errno(buf, 3, iter->field.ptr, |
| 1564 | iter->field.length); |
| 1565 | if (rc) { |
| 1566 | return rc; |
| 1567 | } |
| 1568 | |
| 1569 | pldm_msgbuf_extract(buf, dev->downstream_device_index); |
| 1570 | pldm_msgbuf_extract(buf, dev->downstream_descriptor_count); |
Andrew Jeffery | 3a2c658 | 2024-11-07 16:30:36 +1030 | [diff] [blame] | 1571 | pldm_msgbuf_span_remaining(buf, (void **)&iter->field.ptr, |
| 1572 | &iter->field.length); |
| 1573 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 1574 | return pldm_msgbuf_complete(buf); |
Andrew Jeffery | 3a2c658 | 2024-11-07 16:30:36 +1030 | [diff] [blame] | 1575 | } |
| 1576 | |
Unive Tien | e5c3f14 | 2024-12-13 14:14:19 +0800 | [diff] [blame] | 1577 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 6a97b79 | 2024-12-09 13:46:51 +1030 | [diff] [blame] | 1578 | int encode_get_downstream_firmware_parameters_req( |
Unive Tien | d2f8a7e | 2024-11-27 10:59:34 +0800 | [diff] [blame] | 1579 | uint8_t instance_id, |
Andrew Jeffery | 6a97b79 | 2024-12-09 13:46:51 +1030 | [diff] [blame] | 1580 | const struct pldm_get_downstream_firmware_parameters_req *params_req, |
Unive Tien | d2f8a7e | 2024-11-27 10:59:34 +0800 | [diff] [blame] | 1581 | struct pldm_msg *msg, size_t payload_length) |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1582 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1583 | PLDM_MSGBUF_DEFINE_P(buf); |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1584 | int rc; |
| 1585 | |
Unive Tien | d2f8a7e | 2024-11-27 10:59:34 +0800 | [diff] [blame] | 1586 | if (!msg || !params_req) { |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1587 | return -EINVAL; |
| 1588 | } |
| 1589 | |
Unive Tien | d2f8a7e | 2024-11-27 10:59:34 +0800 | [diff] [blame] | 1590 | if (!is_transfer_operation_flag_valid( |
| 1591 | (enum transfer_op_flag) |
| 1592 | params_req->transfer_operation_flag)) { |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1593 | return -EBADMSG; |
| 1594 | } |
| 1595 | |
| 1596 | struct pldm_header_info header = { 0 }; |
| 1597 | header.instance = instance_id; |
| 1598 | header.msg_type = PLDM_REQUEST; |
| 1599 | header.pldm_type = PLDM_FWUP; |
| 1600 | header.command = PLDM_QUERY_DOWNSTREAM_FIRMWARE_PARAMETERS; |
| 1601 | rc = pack_pldm_header_errno(&header, &msg->hdr); |
| 1602 | if (rc < 0) { |
| 1603 | return rc; |
| 1604 | } |
| 1605 | |
Andrew Jeffery | 53b0867 | 2025-03-04 12:26:18 +1030 | [diff] [blame] | 1606 | rc = pldm_msgbuf_init_errno( |
| 1607 | buf, PLDM_GET_DOWNSTREAM_FIRMWARE_PARAMETERS_REQ_BYTES, |
| 1608 | msg->payload, payload_length); |
| 1609 | if (rc < 0) { |
| 1610 | return rc; |
| 1611 | } |
| 1612 | |
Unive Tien | d2f8a7e | 2024-11-27 10:59:34 +0800 | [diff] [blame] | 1613 | pldm_msgbuf_insert(buf, params_req->data_transfer_handle); |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1614 | // Data correctness has been verified, cast it to 1-byte data directly. |
Unive Tien | d2f8a7e | 2024-11-27 10:59:34 +0800 | [diff] [blame] | 1615 | pldm_msgbuf_insert(buf, params_req->transfer_operation_flag); |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1616 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 1617 | return pldm_msgbuf_complete(buf); |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1618 | } |
| 1619 | |
Unive Tien | e5c3f14 | 2024-12-13 14:14:19 +0800 | [diff] [blame] | 1620 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 6a97b79 | 2024-12-09 13:46:51 +1030 | [diff] [blame] | 1621 | int decode_get_downstream_firmware_parameters_resp( |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1622 | const struct pldm_msg *msg, size_t payload_length, |
Andrew Jeffery | 6a97b79 | 2024-12-09 13:46:51 +1030 | [diff] [blame] | 1623 | struct pldm_get_downstream_firmware_parameters_resp *resp_data, |
Andrew Jeffery | 5a5129b | 2024-12-04 16:12:40 +1030 | [diff] [blame] | 1624 | struct pldm_downstream_device_parameters_iter *iter) |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1625 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1626 | PLDM_MSGBUF_DEFINE_P(buf); |
Andrew Jeffery | 5a5129b | 2024-12-04 16:12:40 +1030 | [diff] [blame] | 1627 | void *remaining = NULL; |
| 1628 | size_t length; |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1629 | int rc; |
| 1630 | |
Andrew Jeffery | 5a5129b | 2024-12-04 16:12:40 +1030 | [diff] [blame] | 1631 | if (msg == NULL || resp_data == NULL || iter == NULL) { |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1632 | return -EINVAL; |
| 1633 | } |
| 1634 | |
| 1635 | rc = pldm_msgbuf_init_errno(buf, PLDM_OPTIONAL_COMMAND_RESP_MIN_LEN, |
| 1636 | msg->payload, payload_length); |
| 1637 | if (rc < 0) { |
| 1638 | return rc; |
| 1639 | } |
| 1640 | |
| 1641 | rc = pldm_msgbuf_extract(buf, resp_data->completion_code); |
| 1642 | if (rc < 0) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1643 | return pldm_msgbuf_discard(buf, rc); |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1644 | } |
| 1645 | if (PLDM_SUCCESS != resp_data->completion_code) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1646 | return pldm_msgbuf_complete(buf); |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1647 | } |
| 1648 | |
Andrew Jeffery | 6a97b79 | 2024-12-09 13:46:51 +1030 | [diff] [blame] | 1649 | if (payload_length < |
| 1650 | PLDM_GET_DOWNSTREAM_FIRMWARE_PARAMETERS_RESP_MIN_LEN) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1651 | return pldm_msgbuf_discard(buf, -EBADMSG); |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1652 | } |
| 1653 | |
| 1654 | pldm_msgbuf_extract(buf, resp_data->next_data_transfer_handle); |
| 1655 | pldm_msgbuf_extract(buf, resp_data->transfer_flag); |
| 1656 | pldm_msgbuf_extract(buf, |
| 1657 | resp_data->fdp_capabilities_during_update.value); |
| 1658 | pldm_msgbuf_extract(buf, resp_data->downstream_device_count); |
| 1659 | |
Andrew Jeffery | 5a5129b | 2024-12-04 16:12:40 +1030 | [diff] [blame] | 1660 | rc = pldm_msgbuf_span_remaining(buf, &remaining, &length); |
| 1661 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1662 | return pldm_msgbuf_discard(buf, rc); |
Andrew Jeffery | 5a5129b | 2024-12-04 16:12:40 +1030 | [diff] [blame] | 1663 | } |
| 1664 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 1665 | rc = pldm_msgbuf_complete(buf); |
Andrew Jeffery | 5a5129b | 2024-12-04 16:12:40 +1030 | [diff] [blame] | 1666 | if (rc) { |
| 1667 | return rc; |
| 1668 | } |
| 1669 | |
| 1670 | iter->field.ptr = remaining; |
| 1671 | iter->field.length = length; |
| 1672 | iter->entries = resp_data->downstream_device_count; |
| 1673 | |
| 1674 | return 0; |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1675 | } |
| 1676 | |
Unive Tien | e5c3f14 | 2024-12-13 14:14:19 +0800 | [diff] [blame] | 1677 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 5a5129b | 2024-12-04 16:12:40 +1030 | [diff] [blame] | 1678 | int decode_pldm_downstream_device_parameters_entry_from_iter( |
| 1679 | struct pldm_downstream_device_parameters_iter *iter, |
| 1680 | struct pldm_downstream_device_parameters_entry *entry) |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1681 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1682 | PLDM_MSGBUF_DEFINE_P(buf); |
Andrew Jeffery | 5a5129b | 2024-12-04 16:12:40 +1030 | [diff] [blame] | 1683 | void *comp_ver_str; |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1684 | size_t remaining; |
Andrew Jeffery | 5a5129b | 2024-12-04 16:12:40 +1030 | [diff] [blame] | 1685 | void *cursor; |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1686 | int rc; |
| 1687 | |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1688 | if (iter == NULL || iter->field.ptr == NULL || entry == NULL) { |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1689 | return -EINVAL; |
| 1690 | } |
| 1691 | |
| 1692 | rc = pldm_msgbuf_init_errno( |
Andrew Jeffery | 5a5129b | 2024-12-04 16:12:40 +1030 | [diff] [blame] | 1693 | buf, PLDM_DOWNSTREAM_DEVICE_PARAMETERS_ENTRY_MIN_LEN, |
| 1694 | iter->field.ptr, iter->field.length); |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1695 | if (rc < 0) { |
| 1696 | return rc; |
| 1697 | } |
| 1698 | |
| 1699 | pldm_msgbuf_extract(buf, entry->downstream_device_index); |
| 1700 | pldm_msgbuf_extract(buf, entry->active_comp_comparison_stamp); |
| 1701 | pldm_msgbuf_extract(buf, entry->active_comp_ver_str_type); |
| 1702 | rc = pldm_msgbuf_extract(buf, entry->active_comp_ver_str_len); |
| 1703 | if (rc < 0) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1704 | return pldm_msgbuf_discard(buf, rc); |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1705 | } |
Andrew Jeffery | 0a1be3c | 2024-08-11 08:34:10 +0000 | [diff] [blame] | 1706 | rc = pldm_msgbuf_extract_array(buf, |
| 1707 | PLDM_FWUP_COMPONENT_RELEASE_DATA_LEN, |
| 1708 | entry->active_comp_release_date, |
| 1709 | sizeof(entry->active_comp_release_date)); |
| 1710 | if (rc < 0) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1711 | return pldm_msgbuf_discard(buf, rc); |
Andrew Jeffery | 0a1be3c | 2024-08-11 08:34:10 +0000 | [diff] [blame] | 1712 | } |
| 1713 | |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1714 | // Fill the last byte with NULL character |
| 1715 | entry->active_comp_release_date[PLDM_FWUP_COMPONENT_RELEASE_DATA_LEN] = |
| 1716 | '\0'; |
| 1717 | |
| 1718 | pldm_msgbuf_extract(buf, entry->pending_comp_comparison_stamp); |
| 1719 | pldm_msgbuf_extract(buf, entry->pending_comp_ver_str_type); |
| 1720 | rc = pldm_msgbuf_extract(buf, entry->pending_comp_ver_str_len); |
| 1721 | if (rc < 0) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1722 | return pldm_msgbuf_discard(buf, rc); |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1723 | } |
Andrew Jeffery | 0a1be3c | 2024-08-11 08:34:10 +0000 | [diff] [blame] | 1724 | |
| 1725 | rc = pldm_msgbuf_extract_array( |
| 1726 | buf, PLDM_FWUP_COMPONENT_RELEASE_DATA_LEN, |
| 1727 | entry->pending_comp_release_date, |
| 1728 | sizeof(entry->pending_comp_release_date)); |
| 1729 | if (rc < 0) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1730 | return pldm_msgbuf_discard(buf, rc); |
Andrew Jeffery | 0a1be3c | 2024-08-11 08:34:10 +0000 | [diff] [blame] | 1731 | } |
| 1732 | |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1733 | // Fill the last byte with NULL character |
| 1734 | entry->pending_comp_release_date[PLDM_FWUP_COMPONENT_RELEASE_DATA_LEN] = |
| 1735 | '\0'; |
| 1736 | |
| 1737 | pldm_msgbuf_extract(buf, entry->comp_activation_methods.value); |
| 1738 | pldm_msgbuf_extract(buf, entry->capabilities_during_update.value); |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1739 | |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1740 | rc = pldm_msgbuf_span_required(buf, entry->active_comp_ver_str_len, |
| 1741 | &comp_ver_str); |
| 1742 | if (rc < 0) { |
| 1743 | return pldm_msgbuf_discard(buf, rc); |
| 1744 | } |
Andrew Jeffery | 5a5129b | 2024-12-04 16:12:40 +1030 | [diff] [blame] | 1745 | entry->active_comp_ver_str = comp_ver_str; |
| 1746 | |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1747 | rc = pldm_msgbuf_span_required(buf, entry->pending_comp_ver_str_len, |
| 1748 | &comp_ver_str); |
| 1749 | if (rc < 0) { |
| 1750 | return pldm_msgbuf_discard(buf, rc); |
| 1751 | } |
Andrew Jeffery | 5a5129b | 2024-12-04 16:12:40 +1030 | [diff] [blame] | 1752 | entry->pending_comp_ver_str = comp_ver_str; |
| 1753 | |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1754 | rc = pldm_msgbuf_span_remaining(buf, &cursor, &remaining); |
| 1755 | if (rc < 0) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1756 | return pldm_msgbuf_discard(buf, rc); |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1757 | } |
| 1758 | |
Andrew Jeffery | 5a5129b | 2024-12-04 16:12:40 +1030 | [diff] [blame] | 1759 | iter->field.ptr = cursor; |
| 1760 | iter->field.length = remaining; |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1761 | |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1762 | return pldm_msgbuf_complete(buf); |
Chris Wang | b6ef35b | 2024-07-03 09:35:42 +0800 | [diff] [blame] | 1763 | } |
| 1764 | |
Sora Su | 06eadd0 | 2025-05-27 11:28:51 +0800 | [diff] [blame] | 1765 | LIBPLDM_ABI_TESTING |
| 1766 | int encode_request_downstream_device_update_req( |
| 1767 | uint8_t instance_id, |
| 1768 | const struct pldm_request_downstream_device_update_req *req_data, |
| 1769 | struct pldm_msg *msg, size_t *payload_length) |
| 1770 | { |
| 1771 | PLDM_MSGBUF_DEFINE_P(buf); |
| 1772 | int rc; |
| 1773 | |
| 1774 | if (!req_data || !msg || !payload_length || |
| 1775 | req_data->maximum_downstream_device_transfer_size < |
| 1776 | PLDM_FWUP_BASELINE_TRANSFER_SIZE || |
| 1777 | req_data->maximum_outstanding_transfer_requests < |
| 1778 | PLDM_FWUP_MIN_OUTSTANDING_REQ) { |
| 1779 | return -EINVAL; |
| 1780 | } |
| 1781 | |
| 1782 | rc = encode_pldm_header_only_errno( |
| 1783 | PLDM_REQUEST, instance_id, PLDM_FWUP, |
| 1784 | PLDM_REQUEST_DOWNSTREAM_DEVICE_UPDATE, msg); |
| 1785 | if (rc) { |
| 1786 | return rc; |
| 1787 | } |
| 1788 | |
| 1789 | rc = pldm_msgbuf_init_errno(buf, |
| 1790 | PLDM_DOWNSTREAM_DEVICE_UPDATE_REQUEST_BYTES, |
| 1791 | msg->payload, *payload_length); |
| 1792 | if (rc) { |
| 1793 | return rc; |
| 1794 | } |
| 1795 | |
| 1796 | pldm_msgbuf_insert(buf, |
| 1797 | req_data->maximum_downstream_device_transfer_size); |
| 1798 | pldm_msgbuf_insert(buf, |
| 1799 | req_data->maximum_outstanding_transfer_requests); |
| 1800 | pldm_msgbuf_insert(buf, |
| 1801 | req_data->downstream_device_package_data_length); |
| 1802 | |
| 1803 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
| 1804 | } |
| 1805 | |
| 1806 | LIBPLDM_ABI_TESTING |
| 1807 | int decode_request_downstream_device_update_req( |
| 1808 | const struct pldm_msg *msg, size_t payload_length, |
| 1809 | struct pldm_request_downstream_device_update_req *req) |
| 1810 | { |
| 1811 | int rc; |
| 1812 | PLDM_MSGBUF_DEFINE_P(buf); |
| 1813 | |
| 1814 | if (!msg || !req) { |
| 1815 | return -EINVAL; |
| 1816 | } |
| 1817 | |
| 1818 | rc = pldm_msgbuf_init_errno(buf, |
| 1819 | PLDM_DOWNSTREAM_DEVICE_UPDATE_REQUEST_BYTES, |
| 1820 | msg->payload, payload_length); |
| 1821 | if (rc) { |
| 1822 | return rc; |
| 1823 | } |
| 1824 | |
| 1825 | pldm_msgbuf_extract(buf, req->maximum_downstream_device_transfer_size); |
| 1826 | pldm_msgbuf_extract(buf, req->maximum_outstanding_transfer_requests); |
| 1827 | pldm_msgbuf_extract(buf, req->downstream_device_package_data_length); |
| 1828 | |
| 1829 | return pldm_msgbuf_complete_consumed(buf); |
| 1830 | } |
| 1831 | |
| 1832 | LIBPLDM_ABI_TESTING |
| 1833 | int encode_request_downstream_device_update_resp( |
| 1834 | uint8_t instance_id, |
| 1835 | const struct pldm_request_downstream_device_update_resp *resp_data, |
| 1836 | struct pldm_msg *msg, size_t *payload_length) |
| 1837 | { |
| 1838 | PLDM_MSGBUF_DEFINE_P(buf); |
| 1839 | int rc; |
| 1840 | |
| 1841 | if (!resp_data || !msg || !payload_length) { |
| 1842 | return -EINVAL; |
| 1843 | } |
| 1844 | |
| 1845 | rc = encode_pldm_header_only_errno( |
| 1846 | PLDM_RESPONSE, instance_id, PLDM_FWUP, |
| 1847 | PLDM_REQUEST_DOWNSTREAM_DEVICE_UPDATE, msg); |
| 1848 | if (rc) { |
| 1849 | return rc; |
| 1850 | } |
| 1851 | |
| 1852 | rc = pldm_msgbuf_init_errno( |
| 1853 | buf, PLDM_DOWNSTREAM_DEVICE_UPDATE_RESPONSE_BYTES, msg->payload, |
| 1854 | *payload_length); |
| 1855 | if (rc) { |
| 1856 | return rc; |
| 1857 | } |
| 1858 | |
| 1859 | pldm_msgbuf_insert(buf, resp_data->completion_code); |
| 1860 | pldm_msgbuf_insert(buf, resp_data->downstream_device_meta_data_length); |
| 1861 | pldm_msgbuf_insert( |
| 1862 | buf, resp_data->downstream_device_will_send_get_package_data); |
| 1863 | pldm_msgbuf_insert(buf, |
| 1864 | resp_data->get_package_data_maximum_transfer_size); |
| 1865 | |
| 1866 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
| 1867 | } |
| 1868 | |
| 1869 | LIBPLDM_ABI_TESTING |
| 1870 | int decode_request_downstream_device_update_resp( |
| 1871 | const struct pldm_msg *msg, size_t payload_length, |
| 1872 | struct pldm_request_downstream_device_update_resp *resp_data) |
| 1873 | { |
| 1874 | PLDM_MSGBUF_DEFINE_P(buf); |
| 1875 | int rc; |
| 1876 | |
| 1877 | if (!msg || !resp_data) { |
| 1878 | return -EINVAL; |
| 1879 | } |
| 1880 | |
| 1881 | rc = pldm_msg_has_error(msg, |
| 1882 | PLDM_DOWNSTREAM_DEVICE_UPDATE_RESPONSE_BYTES); |
| 1883 | if (rc) { |
| 1884 | resp_data->completion_code = rc; |
| 1885 | return 0; |
| 1886 | } |
| 1887 | |
| 1888 | rc = pldm_msgbuf_init_errno( |
| 1889 | buf, PLDM_DOWNSTREAM_DEVICE_UPDATE_RESPONSE_BYTES, msg->payload, |
| 1890 | payload_length); |
| 1891 | if (rc) { |
| 1892 | return rc; |
| 1893 | } |
| 1894 | |
| 1895 | pldm_msgbuf_extract(buf, resp_data->completion_code); |
| 1896 | pldm_msgbuf_extract(buf, resp_data->downstream_device_meta_data_length); |
| 1897 | pldm_msgbuf_extract( |
| 1898 | buf, resp_data->downstream_device_will_send_get_package_data); |
| 1899 | pldm_msgbuf_extract(buf, |
| 1900 | resp_data->get_package_data_maximum_transfer_size); |
| 1901 | |
| 1902 | return pldm_msgbuf_complete_consumed(buf); |
| 1903 | } |
| 1904 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 1905 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1906 | int encode_request_update_req(uint8_t instance_id, uint32_t max_transfer_size, |
| 1907 | uint16_t num_of_comp, |
| 1908 | uint8_t max_outstanding_transfer_req, |
| 1909 | uint16_t pkg_data_len, |
| 1910 | uint8_t comp_image_set_ver_str_type, |
| 1911 | uint8_t comp_image_set_ver_str_len, |
| 1912 | const struct variable_field *comp_img_set_ver_str, |
| 1913 | struct pldm_msg *msg, size_t payload_length) |
| 1914 | { |
| 1915 | if (comp_img_set_ver_str == NULL || comp_img_set_ver_str->ptr == NULL || |
| 1916 | msg == NULL) { |
| 1917 | return PLDM_ERROR_INVALID_DATA; |
| 1918 | } |
| 1919 | |
| 1920 | if (payload_length != sizeof(struct pldm_request_update_req) + |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1921 | comp_img_set_ver_str->length) { |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1922 | return PLDM_ERROR_INVALID_LENGTH; |
| 1923 | } |
| 1924 | |
| 1925 | if ((comp_image_set_ver_str_len == 0) || |
| 1926 | (comp_image_set_ver_str_len != comp_img_set_ver_str->length)) { |
| 1927 | return PLDM_ERROR_INVALID_DATA; |
| 1928 | } |
| 1929 | |
| 1930 | if ((max_transfer_size < PLDM_FWUP_BASELINE_TRANSFER_SIZE) || |
| 1931 | (max_outstanding_transfer_req < PLDM_FWUP_MIN_OUTSTANDING_REQ)) { |
| 1932 | return PLDM_ERROR_INVALID_DATA; |
| 1933 | } |
| 1934 | |
| 1935 | if (!is_string_type_valid(comp_image_set_ver_str_type)) { |
| 1936 | return PLDM_ERROR_INVALID_DATA; |
| 1937 | } |
| 1938 | |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1939 | struct pldm_header_info header = { 0 }; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1940 | header.instance = instance_id; |
| 1941 | header.msg_type = PLDM_REQUEST; |
| 1942 | header.pldm_type = PLDM_FWUP; |
| 1943 | header.command = PLDM_REQUEST_UPDATE; |
| 1944 | uint8_t rc = pack_pldm_header(&header, &(msg->hdr)); |
| 1945 | if (rc) { |
| 1946 | return rc; |
| 1947 | } |
| 1948 | |
| 1949 | struct pldm_request_update_req *request = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 1950 | (struct pldm_request_update_req *)msg->payload; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 1951 | |
| 1952 | request->max_transfer_size = htole32(max_transfer_size); |
| 1953 | request->num_of_comp = htole16(num_of_comp); |
| 1954 | request->max_outstanding_transfer_req = max_outstanding_transfer_req; |
| 1955 | request->pkg_data_len = htole16(pkg_data_len); |
| 1956 | request->comp_image_set_ver_str_type = comp_image_set_ver_str_type; |
| 1957 | request->comp_image_set_ver_str_len = comp_image_set_ver_str_len; |
| 1958 | |
| 1959 | memcpy(msg->payload + sizeof(struct pldm_request_update_req), |
| 1960 | comp_img_set_ver_str->ptr, comp_img_set_ver_str->length); |
| 1961 | |
| 1962 | return PLDM_SUCCESS; |
| 1963 | } |
| 1964 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1965 | LIBPLDM_ABI_TESTING |
| 1966 | int decode_request_update_req(const struct pldm_msg *msg, size_t payload_length, |
| 1967 | struct pldm_request_update_req_full *req) |
| 1968 | { |
| 1969 | int rc; |
| 1970 | uint8_t t; |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1971 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1972 | |
| 1973 | if (msg == NULL || req == NULL) { |
| 1974 | return -EINVAL; |
| 1975 | } |
| 1976 | |
| 1977 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, payload_length); |
| 1978 | if (rc) { |
| 1979 | return rc; |
| 1980 | } |
| 1981 | |
| 1982 | pldm_msgbuf_extract(buf, req->max_transfer_size); |
| 1983 | pldm_msgbuf_extract(buf, req->num_of_comp); |
| 1984 | pldm_msgbuf_extract(buf, req->max_outstanding_transfer_req); |
| 1985 | pldm_msgbuf_extract(buf, req->pkg_data_len); |
| 1986 | rc = pldm_msgbuf_extract(buf, t); |
| 1987 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1988 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1989 | } |
| 1990 | if (t > PLDM_STR_TYPE_UTF_16BE) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1991 | return pldm_msgbuf_discard(buf, -EBADMSG); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1992 | } |
| 1993 | req->image_set_ver.str_type = (enum pldm_firmware_update_string_type)t; |
| 1994 | pldm_msgbuf_extract(buf, req->image_set_ver.str_len); |
| 1995 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 1996 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 1997 | } |
| 1998 | |
| 1999 | rc = pldm_msgbuf_extract_array(buf, req->image_set_ver.str_len, |
| 2000 | req->image_set_ver.str_data, |
| 2001 | PLDM_FIRMWARE_MAX_STRING); |
| 2002 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2003 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2004 | } |
| 2005 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 2006 | return pldm_msgbuf_complete_consumed(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2007 | } |
| 2008 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2009 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2010 | int decode_request_update_resp(const struct pldm_msg *msg, |
| 2011 | size_t payload_length, uint8_t *completion_code, |
| 2012 | uint16_t *fd_meta_data_len, |
| 2013 | uint8_t *fd_will_send_pkg_data) |
| 2014 | { |
| 2015 | if (msg == NULL || completion_code == NULL || |
| 2016 | fd_meta_data_len == NULL || fd_will_send_pkg_data == NULL || |
| 2017 | !payload_length) { |
| 2018 | return PLDM_ERROR_INVALID_DATA; |
| 2019 | } |
| 2020 | |
| 2021 | *completion_code = msg->payload[0]; |
| 2022 | if (*completion_code != PLDM_SUCCESS) { |
| 2023 | return PLDM_SUCCESS; |
| 2024 | } |
| 2025 | |
| 2026 | if (payload_length != sizeof(struct pldm_request_update_resp)) { |
| 2027 | return PLDM_ERROR_INVALID_LENGTH; |
| 2028 | } |
| 2029 | |
| 2030 | struct pldm_request_update_resp *response = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2031 | (struct pldm_request_update_resp *)msg->payload; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2032 | |
| 2033 | *fd_meta_data_len = le16toh(response->fd_meta_data_len); |
| 2034 | *fd_will_send_pkg_data = response->fd_will_send_pkg_data; |
| 2035 | |
| 2036 | return PLDM_SUCCESS; |
| 2037 | } |
| 2038 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2039 | LIBPLDM_ABI_TESTING |
| 2040 | int encode_request_update_resp(uint8_t instance_id, |
| 2041 | const struct pldm_request_update_resp *resp_data, |
| 2042 | struct pldm_msg *msg, size_t *payload_length) |
| 2043 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2044 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2045 | int rc; |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2046 | |
| 2047 | if (msg == NULL || payload_length == NULL) { |
| 2048 | return -EINVAL; |
| 2049 | } |
| 2050 | |
| 2051 | struct pldm_header_info header = { |
| 2052 | .instance = instance_id, |
| 2053 | .msg_type = PLDM_RESPONSE, |
| 2054 | .pldm_type = PLDM_FWUP, |
| 2055 | .command = PLDM_REQUEST_UPDATE, |
| 2056 | }; |
| 2057 | rc = pack_pldm_header(&header, &(msg->hdr)); |
| 2058 | if (rc) { |
| 2059 | return -EINVAL; |
| 2060 | } |
| 2061 | |
| 2062 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, *payload_length); |
| 2063 | if (rc) { |
| 2064 | return rc; |
| 2065 | } |
| 2066 | |
| 2067 | pldm_msgbuf_insert_uint8(buf, PLDM_SUCCESS); |
| 2068 | pldm_msgbuf_insert(buf, resp_data->fd_meta_data_len); |
| 2069 | pldm_msgbuf_insert(buf, resp_data->fd_will_send_pkg_data); |
| 2070 | |
| 2071 | /* TODO: DSP0267 1.3.0 adds GetPackageDataMaximumTransferSize */ |
| 2072 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 2073 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2074 | } |
| 2075 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2076 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2077 | int encode_pass_component_table_req(uint8_t instance_id, uint8_t transfer_flag, |
| 2078 | uint16_t comp_classification, |
| 2079 | uint16_t comp_identifier, |
| 2080 | uint8_t comp_classification_index, |
| 2081 | uint32_t comp_comparison_stamp, |
| 2082 | uint8_t comp_ver_str_type, |
| 2083 | uint8_t comp_ver_str_len, |
| 2084 | const struct variable_field *comp_ver_str, |
| 2085 | struct pldm_msg *msg, size_t payload_length) |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2086 | { |
| 2087 | if (comp_ver_str == NULL || comp_ver_str->ptr == NULL || msg == NULL) { |
| 2088 | return PLDM_ERROR_INVALID_DATA; |
| 2089 | } |
| 2090 | |
| 2091 | if (payload_length != sizeof(struct pldm_pass_component_table_req) + |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2092 | comp_ver_str->length) { |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2093 | return PLDM_ERROR_INVALID_LENGTH; |
| 2094 | } |
| 2095 | |
| 2096 | if ((comp_ver_str_len == 0) || |
| 2097 | (comp_ver_str_len != comp_ver_str->length)) { |
| 2098 | return PLDM_ERROR_INVALID_DATA; |
| 2099 | } |
| 2100 | |
| 2101 | if (!is_transfer_flag_valid(transfer_flag)) { |
Manojkiran Eda | 3643e74 | 2025-05-19 12:03:54 +0530 | [diff] [blame] | 2102 | return PLDM_FWUP_INVALID_TRANSFER_OPERATION_FLAG; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2103 | } |
| 2104 | |
| 2105 | if (!is_string_type_valid(comp_ver_str_type)) { |
| 2106 | return PLDM_ERROR_INVALID_DATA; |
| 2107 | } |
| 2108 | |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2109 | struct pldm_header_info header = { 0 }; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2110 | header.instance = instance_id; |
| 2111 | header.msg_type = PLDM_REQUEST; |
| 2112 | header.pldm_type = PLDM_FWUP; |
| 2113 | header.command = PLDM_PASS_COMPONENT_TABLE; |
| 2114 | uint8_t rc = pack_pldm_header(&header, &(msg->hdr)); |
| 2115 | if (rc) { |
| 2116 | return rc; |
| 2117 | } |
| 2118 | |
| 2119 | struct pldm_pass_component_table_req *request = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2120 | (struct pldm_pass_component_table_req *)msg->payload; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2121 | |
| 2122 | request->transfer_flag = transfer_flag; |
| 2123 | request->comp_classification = htole16(comp_classification); |
| 2124 | request->comp_identifier = htole16(comp_identifier); |
| 2125 | request->comp_classification_index = comp_classification_index; |
| 2126 | request->comp_comparison_stamp = htole32(comp_comparison_stamp); |
| 2127 | request->comp_ver_str_type = comp_ver_str_type; |
| 2128 | request->comp_ver_str_len = comp_ver_str_len; |
| 2129 | |
| 2130 | memcpy(msg->payload + sizeof(struct pldm_pass_component_table_req), |
| 2131 | comp_ver_str->ptr, comp_ver_str->length); |
| 2132 | |
| 2133 | return PLDM_SUCCESS; |
| 2134 | } |
| 2135 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2136 | LIBPLDM_ABI_TESTING |
| 2137 | int decode_pass_component_table_req( |
| 2138 | const struct pldm_msg *msg, size_t payload_length, |
| 2139 | struct pldm_pass_component_table_req_full *pcomp) |
| 2140 | { |
| 2141 | int rc; |
| 2142 | uint8_t t; |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2143 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2144 | |
| 2145 | if (msg == NULL || pcomp == NULL) { |
| 2146 | return -EINVAL; |
| 2147 | } |
| 2148 | |
| 2149 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, payload_length); |
| 2150 | if (rc) { |
| 2151 | return rc; |
| 2152 | } |
| 2153 | |
| 2154 | pldm_msgbuf_extract(buf, pcomp->transfer_flag); |
| 2155 | pldm_msgbuf_extract(buf, pcomp->comp_classification); |
| 2156 | pldm_msgbuf_extract(buf, pcomp->comp_identifier); |
| 2157 | pldm_msgbuf_extract(buf, pcomp->comp_classification_index); |
| 2158 | pldm_msgbuf_extract(buf, pcomp->comp_comparison_stamp); |
| 2159 | rc = pldm_msgbuf_extract(buf, t); |
| 2160 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2161 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2162 | } |
| 2163 | if (t > PLDM_STR_TYPE_UTF_16BE) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2164 | return pldm_msgbuf_discard(buf, -EBADMSG); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2165 | } |
| 2166 | pcomp->version.str_type = (enum pldm_firmware_update_string_type)t; |
| 2167 | rc = pldm_msgbuf_extract(buf, pcomp->version.str_len); |
| 2168 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2169 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2170 | } |
| 2171 | rc = pldm_msgbuf_extract_array(buf, pcomp->version.str_len, |
| 2172 | pcomp->version.str_data, |
| 2173 | PLDM_FIRMWARE_MAX_STRING); |
| 2174 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2175 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2176 | } |
| 2177 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 2178 | return pldm_msgbuf_complete_consumed(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2179 | } |
| 2180 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2181 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2182 | int decode_pass_component_table_resp(const struct pldm_msg *msg, |
| 2183 | const size_t payload_length, |
| 2184 | uint8_t *completion_code, |
| 2185 | uint8_t *comp_resp, |
| 2186 | uint8_t *comp_resp_code) |
| 2187 | { |
| 2188 | if (msg == NULL || completion_code == NULL || comp_resp == NULL || |
| 2189 | comp_resp_code == NULL || !payload_length) { |
| 2190 | return PLDM_ERROR_INVALID_DATA; |
| 2191 | } |
| 2192 | |
| 2193 | *completion_code = msg->payload[0]; |
| 2194 | if (*completion_code != PLDM_SUCCESS) { |
| 2195 | return PLDM_SUCCESS; |
| 2196 | } |
| 2197 | |
| 2198 | if (payload_length != sizeof(struct pldm_pass_component_table_resp)) { |
| 2199 | return PLDM_ERROR_INVALID_LENGTH; |
| 2200 | } |
| 2201 | |
| 2202 | struct pldm_pass_component_table_resp *response = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2203 | (struct pldm_pass_component_table_resp *)msg->payload; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2204 | |
| 2205 | if (!is_comp_resp_valid(response->comp_resp)) { |
| 2206 | return PLDM_ERROR_INVALID_DATA; |
| 2207 | } |
| 2208 | |
| 2209 | if (!is_comp_resp_code_valid(response->comp_resp_code)) { |
| 2210 | return PLDM_ERROR_INVALID_DATA; |
| 2211 | } |
| 2212 | |
| 2213 | *comp_resp = response->comp_resp; |
| 2214 | *comp_resp_code = response->comp_resp_code; |
| 2215 | |
| 2216 | return PLDM_SUCCESS; |
| 2217 | } |
| 2218 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2219 | LIBPLDM_ABI_TESTING |
| 2220 | int encode_pass_component_table_resp( |
| 2221 | uint8_t instance_id, |
| 2222 | const struct pldm_pass_component_table_resp *resp_data, |
| 2223 | struct pldm_msg *msg, size_t *payload_length) |
| 2224 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2225 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2226 | int rc; |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2227 | |
| 2228 | if (msg == NULL || payload_length == NULL) { |
| 2229 | return -EINVAL; |
| 2230 | } |
| 2231 | |
| 2232 | rc = encode_pldm_header_only(PLDM_RESPONSE, instance_id, PLDM_FWUP, |
| 2233 | PLDM_PASS_COMPONENT_TABLE, msg); |
| 2234 | if (rc) { |
| 2235 | return -EINVAL; |
| 2236 | } |
| 2237 | |
| 2238 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, *payload_length); |
| 2239 | if (rc) { |
| 2240 | return rc; |
| 2241 | } |
| 2242 | |
| 2243 | pldm_msgbuf_insert_uint8(buf, PLDM_SUCCESS); |
| 2244 | pldm_msgbuf_insert(buf, resp_data->comp_resp); |
| 2245 | pldm_msgbuf_insert(buf, resp_data->comp_resp_code); |
| 2246 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 2247 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2248 | } |
| 2249 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2250 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2251 | int encode_update_component_req( |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2252 | uint8_t instance_id, uint16_t comp_classification, |
| 2253 | uint16_t comp_identifier, uint8_t comp_classification_index, |
| 2254 | uint32_t comp_comparison_stamp, uint32_t comp_image_size, |
| 2255 | bitfield32_t update_option_flags, uint8_t comp_ver_str_type, |
| 2256 | uint8_t comp_ver_str_len, const struct variable_field *comp_ver_str, |
| 2257 | struct pldm_msg *msg, size_t payload_length) |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2258 | { |
| 2259 | if (comp_ver_str == NULL || comp_ver_str->ptr == NULL || msg == NULL) { |
| 2260 | return PLDM_ERROR_INVALID_DATA; |
| 2261 | } |
| 2262 | |
| 2263 | if (payload_length != |
| 2264 | sizeof(struct pldm_update_component_req) + comp_ver_str->length) { |
| 2265 | return PLDM_ERROR_INVALID_LENGTH; |
| 2266 | } |
| 2267 | |
| 2268 | if (!comp_image_size) { |
| 2269 | return PLDM_ERROR_INVALID_DATA; |
| 2270 | } |
| 2271 | |
| 2272 | if ((comp_ver_str_len == 0) || |
| 2273 | (comp_ver_str_len != comp_ver_str->length)) { |
| 2274 | return PLDM_ERROR_INVALID_DATA; |
| 2275 | } |
| 2276 | |
| 2277 | if (!is_string_type_valid(comp_ver_str_type)) { |
| 2278 | return PLDM_ERROR_INVALID_DATA; |
| 2279 | } |
| 2280 | |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2281 | struct pldm_header_info header = { 0 }; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2282 | header.instance = instance_id; |
| 2283 | header.msg_type = PLDM_REQUEST; |
| 2284 | header.pldm_type = PLDM_FWUP; |
| 2285 | header.command = PLDM_UPDATE_COMPONENT; |
| 2286 | uint8_t rc = pack_pldm_header(&header, &(msg->hdr)); |
| 2287 | if (rc) { |
| 2288 | return rc; |
| 2289 | } |
| 2290 | |
| 2291 | struct pldm_update_component_req *request = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2292 | (struct pldm_update_component_req *)msg->payload; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2293 | |
| 2294 | request->comp_classification = htole16(comp_classification); |
| 2295 | request->comp_identifier = htole16(comp_identifier); |
| 2296 | request->comp_classification_index = comp_classification_index; |
| 2297 | request->comp_comparison_stamp = htole32(comp_comparison_stamp); |
| 2298 | request->comp_image_size = htole32(comp_image_size); |
| 2299 | request->update_option_flags.value = htole32(update_option_flags.value); |
| 2300 | request->comp_ver_str_type = comp_ver_str_type; |
| 2301 | request->comp_ver_str_len = comp_ver_str_len; |
| 2302 | |
| 2303 | memcpy(msg->payload + sizeof(struct pldm_update_component_req), |
| 2304 | comp_ver_str->ptr, comp_ver_str->length); |
| 2305 | |
| 2306 | return PLDM_SUCCESS; |
| 2307 | } |
| 2308 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2309 | LIBPLDM_ABI_TESTING |
| 2310 | int decode_update_component_req(const struct pldm_msg *msg, |
| 2311 | size_t payload_length, |
| 2312 | struct pldm_update_component_req_full *up) |
| 2313 | { |
| 2314 | int rc; |
| 2315 | uint8_t t; |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2316 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2317 | |
| 2318 | if (msg == NULL || up == NULL) { |
| 2319 | return -EINVAL; |
| 2320 | } |
| 2321 | |
| 2322 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, payload_length); |
| 2323 | if (rc) { |
| 2324 | return rc; |
| 2325 | } |
| 2326 | |
| 2327 | pldm_msgbuf_extract(buf, up->comp_classification); |
| 2328 | pldm_msgbuf_extract(buf, up->comp_identifier); |
| 2329 | pldm_msgbuf_extract(buf, up->comp_classification_index); |
| 2330 | pldm_msgbuf_extract(buf, up->comp_comparison_stamp); |
| 2331 | pldm_msgbuf_extract(buf, up->comp_image_size); |
| 2332 | pldm_msgbuf_extract(buf, up->update_option_flags.value); |
| 2333 | rc = pldm_msgbuf_extract(buf, t); |
| 2334 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2335 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2336 | } |
| 2337 | if (t > PLDM_STR_TYPE_UTF_16BE) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2338 | return pldm_msgbuf_discard(buf, -EBADMSG); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2339 | } |
| 2340 | up->version.str_type = (enum pldm_firmware_update_string_type)t; |
| 2341 | rc = pldm_msgbuf_extract(buf, up->version.str_len); |
| 2342 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2343 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2344 | } |
| 2345 | rc = pldm_msgbuf_extract_array(buf, up->version.str_len, |
| 2346 | up->version.str_data, |
| 2347 | PLDM_FIRMWARE_MAX_STRING); |
| 2348 | if (rc) { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2349 | return pldm_msgbuf_discard(buf, rc); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2350 | } |
| 2351 | |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2352 | return pldm_msgbuf_complete_consumed(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2353 | } |
| 2354 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2355 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2356 | int decode_update_component_resp(const struct pldm_msg *msg, |
| 2357 | size_t payload_length, |
| 2358 | uint8_t *completion_code, |
| 2359 | uint8_t *comp_compatibility_resp, |
| 2360 | uint8_t *comp_compatibility_resp_code, |
| 2361 | bitfield32_t *update_option_flags_enabled, |
| 2362 | uint16_t *time_before_req_fw_data) |
| 2363 | { |
| 2364 | if (msg == NULL || completion_code == NULL || |
| 2365 | comp_compatibility_resp == NULL || |
| 2366 | comp_compatibility_resp_code == NULL || |
| 2367 | update_option_flags_enabled == NULL || |
| 2368 | time_before_req_fw_data == NULL || !payload_length) { |
| 2369 | return PLDM_ERROR_INVALID_DATA; |
| 2370 | } |
| 2371 | |
| 2372 | *completion_code = msg->payload[0]; |
| 2373 | if (*completion_code != PLDM_SUCCESS) { |
| 2374 | return PLDM_SUCCESS; |
| 2375 | } |
| 2376 | |
| 2377 | if (payload_length != sizeof(struct pldm_update_component_resp)) { |
| 2378 | return PLDM_ERROR_INVALID_LENGTH; |
| 2379 | } |
| 2380 | |
| 2381 | struct pldm_update_component_resp *response = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2382 | (struct pldm_update_component_resp *)msg->payload; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2383 | |
| 2384 | if (!is_comp_compatibility_resp_valid( |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2385 | response->comp_compatibility_resp)) { |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2386 | return PLDM_ERROR_INVALID_DATA; |
| 2387 | } |
| 2388 | |
| 2389 | if (!is_comp_compatibility_resp_code_valid( |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2390 | response->comp_compatibility_resp_code)) { |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2391 | return PLDM_ERROR_INVALID_DATA; |
| 2392 | } |
| 2393 | |
| 2394 | *comp_compatibility_resp = response->comp_compatibility_resp; |
| 2395 | *comp_compatibility_resp_code = response->comp_compatibility_resp_code; |
| 2396 | update_option_flags_enabled->value = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2397 | le32toh(response->update_option_flags_enabled.value); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2398 | *time_before_req_fw_data = le16toh(response->time_before_req_fw_data); |
| 2399 | |
| 2400 | return PLDM_SUCCESS; |
| 2401 | } |
| 2402 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2403 | LIBPLDM_ABI_TESTING |
| 2404 | int encode_update_component_resp( |
| 2405 | uint8_t instance_id, const struct pldm_update_component_resp *resp_data, |
| 2406 | struct pldm_msg *msg, size_t *payload_length) |
| 2407 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2408 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2409 | int rc; |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2410 | |
| 2411 | if (msg == NULL || payload_length == NULL) { |
| 2412 | return -EINVAL; |
| 2413 | } |
| 2414 | |
| 2415 | rc = encode_pldm_header_only(PLDM_RESPONSE, instance_id, PLDM_FWUP, |
| 2416 | PLDM_UPDATE_COMPONENT, msg); |
| 2417 | if (rc) { |
| 2418 | return -EINVAL; |
| 2419 | } |
| 2420 | |
| 2421 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, *payload_length); |
| 2422 | if (rc) { |
| 2423 | return rc; |
| 2424 | } |
| 2425 | |
| 2426 | pldm_msgbuf_insert_uint8(buf, PLDM_SUCCESS); |
| 2427 | pldm_msgbuf_insert(buf, resp_data->comp_compatibility_resp); |
| 2428 | pldm_msgbuf_insert(buf, resp_data->comp_compatibility_resp_code); |
| 2429 | pldm_msgbuf_insert(buf, resp_data->update_option_flags_enabled.value); |
| 2430 | pldm_msgbuf_insert(buf, resp_data->time_before_req_fw_data); |
| 2431 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 2432 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2433 | } |
| 2434 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2435 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2436 | int decode_request_firmware_data_req(const struct pldm_msg *msg, |
| 2437 | size_t payload_length, uint32_t *offset, |
| 2438 | uint32_t *length) |
| 2439 | { |
| 2440 | if (msg == NULL || offset == NULL || length == NULL) { |
| 2441 | return PLDM_ERROR_INVALID_DATA; |
| 2442 | } |
| 2443 | if (payload_length != sizeof(struct pldm_request_firmware_data_req)) { |
| 2444 | return PLDM_ERROR_INVALID_LENGTH; |
| 2445 | } |
| 2446 | struct pldm_request_firmware_data_req *request = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2447 | (struct pldm_request_firmware_data_req *)msg->payload; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2448 | *offset = le32toh(request->offset); |
| 2449 | *length = le32toh(request->length); |
| 2450 | |
| 2451 | if (*length < PLDM_FWUP_BASELINE_TRANSFER_SIZE) { |
| 2452 | return PLDM_FWUP_INVALID_TRANSFER_LENGTH; |
| 2453 | } |
| 2454 | |
| 2455 | return PLDM_SUCCESS; |
| 2456 | } |
| 2457 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2458 | LIBPLDM_ABI_TESTING |
| 2459 | int encode_request_firmware_data_req( |
| 2460 | uint8_t instance_id, |
| 2461 | const struct pldm_request_firmware_data_req *req_params, |
| 2462 | struct pldm_msg *msg, size_t *payload_length) |
| 2463 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2464 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2465 | int rc; |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2466 | |
| 2467 | if (msg == NULL || payload_length == NULL) { |
| 2468 | return -EINVAL; |
| 2469 | } |
| 2470 | |
| 2471 | rc = encode_pldm_header_only(PLDM_REQUEST, instance_id, PLDM_FWUP, |
| 2472 | PLDM_REQUEST_FIRMWARE_DATA, msg); |
| 2473 | if (rc) { |
| 2474 | return -EINVAL; |
| 2475 | } |
| 2476 | |
| 2477 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, *payload_length); |
| 2478 | if (rc) { |
| 2479 | return rc; |
| 2480 | } |
| 2481 | |
| 2482 | pldm_msgbuf_insert(buf, req_params->offset); |
| 2483 | pldm_msgbuf_insert(buf, req_params->length); |
| 2484 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 2485 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2486 | } |
| 2487 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2488 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2489 | int encode_request_firmware_data_resp(uint8_t instance_id, |
| 2490 | uint8_t completion_code, |
| 2491 | struct pldm_msg *msg, |
| 2492 | size_t payload_length) |
| 2493 | { |
| 2494 | if (msg == NULL || !payload_length) { |
| 2495 | return PLDM_ERROR_INVALID_DATA; |
| 2496 | } |
| 2497 | |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2498 | struct pldm_header_info header = { 0 }; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2499 | header.instance = instance_id; |
| 2500 | header.msg_type = PLDM_RESPONSE; |
| 2501 | header.pldm_type = PLDM_FWUP; |
| 2502 | header.command = PLDM_REQUEST_FIRMWARE_DATA; |
| 2503 | uint8_t rc = pack_pldm_header(&header, &(msg->hdr)); |
| 2504 | if (rc) { |
| 2505 | return rc; |
| 2506 | } |
| 2507 | |
| 2508 | msg->payload[0] = completion_code; |
| 2509 | |
| 2510 | return PLDM_SUCCESS; |
| 2511 | } |
| 2512 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2513 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2514 | int decode_transfer_complete_req(const struct pldm_msg *msg, |
| 2515 | size_t payload_length, |
| 2516 | uint8_t *transfer_result) |
| 2517 | { |
| 2518 | if (msg == NULL || transfer_result == NULL) { |
| 2519 | return PLDM_ERROR_INVALID_DATA; |
| 2520 | } |
| 2521 | |
| 2522 | if (payload_length != sizeof(*transfer_result)) { |
| 2523 | return PLDM_ERROR_INVALID_LENGTH; |
| 2524 | } |
| 2525 | |
| 2526 | *transfer_result = msg->payload[0]; |
| 2527 | return PLDM_SUCCESS; |
| 2528 | } |
| 2529 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2530 | LIBPLDM_ABI_TESTING |
| 2531 | int encode_transfer_complete_req(uint8_t instance_id, uint8_t transfer_result, |
| 2532 | struct pldm_msg *msg, size_t *payload_length) |
| 2533 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2534 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2535 | int rc; |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2536 | |
| 2537 | if (msg == NULL || payload_length == NULL) { |
| 2538 | return -EINVAL; |
| 2539 | } |
| 2540 | |
| 2541 | rc = encode_pldm_header_only(PLDM_REQUEST, instance_id, PLDM_FWUP, |
| 2542 | PLDM_TRANSFER_COMPLETE, msg); |
| 2543 | if (rc) { |
| 2544 | return -EINVAL; |
| 2545 | } |
| 2546 | |
| 2547 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, *payload_length); |
| 2548 | if (rc) { |
| 2549 | return rc; |
| 2550 | } |
| 2551 | |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2552 | pldm_msgbuf_insert(buf, transfer_result); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2553 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 2554 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2555 | } |
| 2556 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2557 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2558 | int encode_transfer_complete_resp(uint8_t instance_id, uint8_t completion_code, |
| 2559 | struct pldm_msg *msg, size_t payload_length) |
| 2560 | { |
| 2561 | if (msg == NULL) { |
| 2562 | return PLDM_ERROR_INVALID_DATA; |
| 2563 | } |
| 2564 | |
| 2565 | if (payload_length != sizeof(completion_code)) { |
| 2566 | return PLDM_ERROR_INVALID_LENGTH; |
| 2567 | } |
| 2568 | |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2569 | struct pldm_header_info header = { 0 }; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2570 | header.instance = instance_id; |
| 2571 | header.msg_type = PLDM_RESPONSE; |
| 2572 | header.pldm_type = PLDM_FWUP; |
| 2573 | header.command = PLDM_TRANSFER_COMPLETE; |
| 2574 | uint8_t rc = pack_pldm_header(&header, &(msg->hdr)); |
| 2575 | if (rc) { |
| 2576 | return rc; |
| 2577 | } |
| 2578 | |
| 2579 | msg->payload[0] = completion_code; |
| 2580 | |
| 2581 | return PLDM_SUCCESS; |
| 2582 | } |
| 2583 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2584 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2585 | int decode_verify_complete_req(const struct pldm_msg *msg, |
| 2586 | size_t payload_length, uint8_t *verify_result) |
| 2587 | { |
| 2588 | if (msg == NULL || verify_result == NULL) { |
| 2589 | return PLDM_ERROR_INVALID_DATA; |
| 2590 | } |
| 2591 | |
| 2592 | if (payload_length != sizeof(*verify_result)) { |
| 2593 | return PLDM_ERROR_INVALID_LENGTH; |
| 2594 | } |
| 2595 | |
| 2596 | *verify_result = msg->payload[0]; |
| 2597 | return PLDM_SUCCESS; |
| 2598 | } |
| 2599 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2600 | LIBPLDM_ABI_TESTING |
| 2601 | int encode_verify_complete_req(uint8_t instance_id, uint8_t verify_result, |
| 2602 | struct pldm_msg *msg, size_t *payload_length) |
| 2603 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2604 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2605 | int rc; |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2606 | |
| 2607 | if (msg == NULL || payload_length == NULL) { |
| 2608 | return -EINVAL; |
| 2609 | } |
| 2610 | |
| 2611 | rc = encode_pldm_header_only(PLDM_REQUEST, instance_id, PLDM_FWUP, |
| 2612 | PLDM_VERIFY_COMPLETE, msg); |
| 2613 | if (rc) { |
| 2614 | return EINVAL; |
| 2615 | } |
| 2616 | |
| 2617 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, *payload_length); |
| 2618 | if (rc) { |
| 2619 | return rc; |
| 2620 | } |
| 2621 | |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2622 | pldm_msgbuf_insert(buf, verify_result); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2623 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 2624 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2625 | } |
| 2626 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2627 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2628 | int encode_verify_complete_resp(uint8_t instance_id, uint8_t completion_code, |
| 2629 | struct pldm_msg *msg, size_t payload_length) |
| 2630 | { |
| 2631 | if (msg == NULL) { |
| 2632 | return PLDM_ERROR_INVALID_DATA; |
| 2633 | } |
| 2634 | |
| 2635 | if (payload_length != sizeof(completion_code)) { |
| 2636 | return PLDM_ERROR_INVALID_LENGTH; |
| 2637 | } |
| 2638 | |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2639 | struct pldm_header_info header = { 0 }; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2640 | header.instance = instance_id; |
| 2641 | header.msg_type = PLDM_RESPONSE; |
| 2642 | header.pldm_type = PLDM_FWUP; |
| 2643 | header.command = PLDM_VERIFY_COMPLETE; |
| 2644 | uint8_t rc = pack_pldm_header(&header, &(msg->hdr)); |
| 2645 | if (rc) { |
| 2646 | return rc; |
| 2647 | } |
| 2648 | |
| 2649 | msg->payload[0] = completion_code; |
| 2650 | |
| 2651 | return PLDM_SUCCESS; |
| 2652 | } |
| 2653 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2654 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2655 | int decode_apply_complete_req(const struct pldm_msg *msg, size_t payload_length, |
| 2656 | uint8_t *apply_result, |
| 2657 | bitfield16_t *comp_activation_methods_modification) |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2658 | { |
| 2659 | if (msg == NULL || apply_result == NULL || |
| 2660 | comp_activation_methods_modification == NULL) { |
| 2661 | return PLDM_ERROR_INVALID_DATA; |
| 2662 | } |
| 2663 | |
| 2664 | if (payload_length != sizeof(struct pldm_apply_complete_req)) { |
| 2665 | return PLDM_ERROR_INVALID_LENGTH; |
| 2666 | } |
| 2667 | |
| 2668 | struct pldm_apply_complete_req *request = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2669 | (struct pldm_apply_complete_req *)msg->payload; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2670 | |
| 2671 | *apply_result = request->apply_result; |
| 2672 | comp_activation_methods_modification->value = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2673 | le16toh(request->comp_activation_methods_modification.value); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2674 | |
| 2675 | if ((*apply_result != PLDM_FWUP_APPLY_SUCCESS_WITH_ACTIVATION_METHOD) && |
| 2676 | comp_activation_methods_modification->value) { |
| 2677 | return PLDM_ERROR_INVALID_DATA; |
| 2678 | } |
| 2679 | |
| 2680 | return PLDM_SUCCESS; |
| 2681 | } |
| 2682 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2683 | LIBPLDM_ABI_TESTING |
| 2684 | int encode_apply_complete_req(uint8_t instance_id, |
| 2685 | const struct pldm_apply_complete_req *req_data, |
| 2686 | struct pldm_msg *msg, size_t *payload_length) |
| 2687 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2688 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2689 | int rc; |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2690 | |
| 2691 | if (msg == NULL || payload_length == NULL) { |
| 2692 | return -EINVAL; |
| 2693 | } |
| 2694 | |
| 2695 | rc = encode_pldm_header_only(PLDM_REQUEST, instance_id, PLDM_FWUP, |
| 2696 | PLDM_APPLY_COMPLETE, msg); |
| 2697 | if (rc) { |
| 2698 | return -EINVAL; |
| 2699 | } |
| 2700 | |
| 2701 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, *payload_length); |
| 2702 | if (rc) { |
| 2703 | return rc; |
| 2704 | } |
| 2705 | |
| 2706 | pldm_msgbuf_insert(buf, req_data->apply_result); |
| 2707 | pldm_msgbuf_insert( |
| 2708 | buf, req_data->comp_activation_methods_modification.value); |
| 2709 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 2710 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2711 | } |
| 2712 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2713 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2714 | int encode_apply_complete_resp(uint8_t instance_id, uint8_t completion_code, |
| 2715 | struct pldm_msg *msg, size_t payload_length) |
| 2716 | { |
| 2717 | if (msg == NULL) { |
| 2718 | return PLDM_ERROR_INVALID_DATA; |
| 2719 | } |
| 2720 | |
| 2721 | if (payload_length != sizeof(completion_code)) { |
| 2722 | return PLDM_ERROR_INVALID_LENGTH; |
| 2723 | } |
| 2724 | |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2725 | struct pldm_header_info header = { 0 }; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2726 | header.instance = instance_id; |
| 2727 | header.msg_type = PLDM_RESPONSE; |
| 2728 | header.pldm_type = PLDM_FWUP; |
| 2729 | header.command = PLDM_APPLY_COMPLETE; |
| 2730 | uint8_t rc = pack_pldm_header(&header, &(msg->hdr)); |
| 2731 | if (rc) { |
| 2732 | return rc; |
| 2733 | } |
| 2734 | |
| 2735 | msg->payload[0] = completion_code; |
| 2736 | |
| 2737 | return PLDM_SUCCESS; |
| 2738 | } |
| 2739 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2740 | LIBPLDM_ABI_TESTING |
| 2741 | int decode_activate_firmware_req(const struct pldm_msg *msg, |
| 2742 | size_t payload_length, bool *self_contained) |
| 2743 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2744 | uint8_t self_contained_u8 = 0; |
| 2745 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2746 | int rc; |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2747 | |
| 2748 | if (msg == NULL || self_contained == NULL) { |
| 2749 | return -EINVAL; |
| 2750 | } |
| 2751 | |
| 2752 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, payload_length); |
| 2753 | if (rc) { |
| 2754 | return 0; |
| 2755 | } |
| 2756 | |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2757 | pldm_msgbuf_extract(buf, self_contained_u8); |
| 2758 | |
| 2759 | rc = pldm_msgbuf_complete_consumed(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2760 | if (rc) { |
| 2761 | return rc; |
| 2762 | } |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2763 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2764 | *self_contained = (bool)self_contained_u8; |
| 2765 | return 0; |
| 2766 | } |
| 2767 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2768 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2769 | int encode_activate_firmware_req(uint8_t instance_id, |
| 2770 | bool8_t self_contained_activation_req, |
| 2771 | struct pldm_msg *msg, size_t payload_length) |
| 2772 | { |
| 2773 | if (msg == NULL) { |
| 2774 | return PLDM_ERROR_INVALID_DATA; |
| 2775 | } |
| 2776 | |
| 2777 | if (payload_length != sizeof(struct pldm_activate_firmware_req)) { |
| 2778 | return PLDM_ERROR_INVALID_LENGTH; |
| 2779 | } |
| 2780 | |
| 2781 | if (!is_self_contained_activation_req_valid( |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2782 | self_contained_activation_req)) { |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2783 | return PLDM_ERROR_INVALID_DATA; |
| 2784 | } |
| 2785 | |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2786 | struct pldm_header_info header = { 0 }; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2787 | header.instance = instance_id; |
| 2788 | header.msg_type = PLDM_REQUEST; |
| 2789 | header.pldm_type = PLDM_FWUP; |
| 2790 | header.command = PLDM_ACTIVATE_FIRMWARE; |
| 2791 | uint8_t rc = pack_pldm_header(&header, &(msg->hdr)); |
| 2792 | if (rc) { |
| 2793 | return rc; |
| 2794 | } |
| 2795 | |
| 2796 | struct pldm_activate_firmware_req *request = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2797 | (struct pldm_activate_firmware_req *)msg->payload; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2798 | |
| 2799 | request->self_contained_activation_req = self_contained_activation_req; |
| 2800 | |
| 2801 | return PLDM_SUCCESS; |
| 2802 | } |
| 2803 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2804 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2805 | int decode_activate_firmware_resp(const struct pldm_msg *msg, |
| 2806 | size_t payload_length, |
| 2807 | uint8_t *completion_code, |
| 2808 | uint16_t *estimated_time_activation) |
| 2809 | { |
| 2810 | if (msg == NULL || completion_code == NULL || |
| 2811 | estimated_time_activation == NULL || !payload_length) { |
| 2812 | return PLDM_ERROR_INVALID_DATA; |
| 2813 | } |
| 2814 | |
| 2815 | *completion_code = msg->payload[0]; |
| 2816 | if (*completion_code != PLDM_SUCCESS) { |
| 2817 | return PLDM_SUCCESS; |
| 2818 | } |
| 2819 | |
| 2820 | if (payload_length != sizeof(struct pldm_activate_firmware_resp)) { |
| 2821 | return PLDM_ERROR_INVALID_LENGTH; |
| 2822 | } |
| 2823 | |
| 2824 | struct pldm_activate_firmware_resp *response = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2825 | (struct pldm_activate_firmware_resp *)msg->payload; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2826 | |
| 2827 | *estimated_time_activation = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2828 | le16toh(response->estimated_time_activation); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2829 | |
| 2830 | return PLDM_SUCCESS; |
| 2831 | } |
| 2832 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2833 | LIBPLDM_ABI_TESTING |
| 2834 | int encode_activate_firmware_resp( |
| 2835 | uint8_t instance_id, |
| 2836 | const struct pldm_activate_firmware_resp *resp_data, |
| 2837 | struct pldm_msg *msg, size_t *payload_length) |
| 2838 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2839 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2840 | int rc; |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2841 | |
| 2842 | if (msg == NULL || payload_length == NULL) { |
| 2843 | return -EINVAL; |
| 2844 | } |
| 2845 | |
| 2846 | rc = encode_pldm_header_only(PLDM_RESPONSE, instance_id, PLDM_FWUP, |
| 2847 | PLDM_ACTIVATE_FIRMWARE, msg); |
| 2848 | if (rc) { |
| 2849 | return -EINVAL; |
| 2850 | } |
| 2851 | |
| 2852 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, *payload_length); |
| 2853 | if (rc) { |
| 2854 | return rc; |
| 2855 | } |
| 2856 | |
| 2857 | pldm_msgbuf_insert_uint8(buf, PLDM_SUCCESS); |
| 2858 | pldm_msgbuf_insert(buf, resp_data->estimated_time_activation); |
| 2859 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 2860 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2861 | } |
| 2862 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2863 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2864 | int encode_get_status_req(uint8_t instance_id, struct pldm_msg *msg, |
| 2865 | size_t payload_length) |
| 2866 | { |
| 2867 | if (msg == NULL) { |
| 2868 | return PLDM_ERROR_INVALID_DATA; |
| 2869 | } |
| 2870 | |
| 2871 | if (payload_length != PLDM_GET_STATUS_REQ_BYTES) { |
| 2872 | return PLDM_ERROR_INVALID_LENGTH; |
| 2873 | } |
| 2874 | |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2875 | struct pldm_header_info header = { 0 }; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2876 | header.instance = instance_id; |
| 2877 | header.msg_type = PLDM_REQUEST; |
| 2878 | header.pldm_type = PLDM_FWUP; |
| 2879 | header.command = PLDM_GET_STATUS; |
| 2880 | uint8_t rc = pack_pldm_header(&header, &(msg->hdr)); |
| 2881 | if (rc) { |
| 2882 | return rc; |
| 2883 | } |
| 2884 | |
| 2885 | return PLDM_SUCCESS; |
| 2886 | } |
| 2887 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2888 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2889 | int decode_get_status_resp(const struct pldm_msg *msg, size_t payload_length, |
| 2890 | uint8_t *completion_code, uint8_t *current_state, |
| 2891 | uint8_t *previous_state, uint8_t *aux_state, |
| 2892 | uint8_t *aux_state_status, uint8_t *progress_percent, |
| 2893 | uint8_t *reason_code, |
| 2894 | bitfield32_t *update_option_flags_enabled) |
| 2895 | { |
| 2896 | if (msg == NULL || completion_code == NULL || current_state == NULL || |
| 2897 | previous_state == NULL || aux_state == NULL || |
| 2898 | aux_state_status == NULL || progress_percent == NULL || |
| 2899 | reason_code == NULL || update_option_flags_enabled == NULL || |
| 2900 | !payload_length) { |
| 2901 | return PLDM_ERROR_INVALID_DATA; |
| 2902 | } |
| 2903 | |
| 2904 | *completion_code = msg->payload[0]; |
| 2905 | if (*completion_code != PLDM_SUCCESS) { |
| 2906 | return PLDM_SUCCESS; |
| 2907 | } |
| 2908 | |
| 2909 | if (payload_length != sizeof(struct pldm_get_status_resp)) { |
| 2910 | return PLDM_ERROR_INVALID_LENGTH; |
| 2911 | } |
| 2912 | struct pldm_get_status_resp *response = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2913 | (struct pldm_get_status_resp *)msg->payload; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2914 | |
| 2915 | if (!is_state_valid(response->current_state)) { |
| 2916 | return PLDM_ERROR_INVALID_DATA; |
| 2917 | } |
| 2918 | if (!is_state_valid(response->previous_state)) { |
| 2919 | return PLDM_ERROR_INVALID_DATA; |
| 2920 | } |
| 2921 | if (!is_aux_state_valid(response->aux_state)) { |
| 2922 | return PLDM_ERROR_INVALID_DATA; |
| 2923 | } |
| 2924 | if (!is_aux_state_status_valid(response->aux_state_status)) { |
| 2925 | return PLDM_ERROR_INVALID_DATA; |
| 2926 | } |
| 2927 | if (response->progress_percent > PLDM_FWUP_MAX_PROGRESS_PERCENT) { |
| 2928 | return PLDM_ERROR_INVALID_DATA; |
| 2929 | } |
| 2930 | if (!is_reason_code_valid(response->reason_code)) { |
| 2931 | return PLDM_ERROR_INVALID_DATA; |
| 2932 | } |
| 2933 | |
| 2934 | if ((response->current_state == PLDM_FD_STATE_IDLE) || |
| 2935 | (response->current_state == PLDM_FD_STATE_LEARN_COMPONENTS) || |
| 2936 | (response->current_state == PLDM_FD_STATE_READY_XFER)) { |
| 2937 | if (response->aux_state != |
| 2938 | PLDM_FD_IDLE_LEARN_COMPONENTS_READ_XFER) { |
| 2939 | return PLDM_ERROR_INVALID_DATA; |
| 2940 | } |
| 2941 | } |
| 2942 | |
| 2943 | *current_state = response->current_state; |
| 2944 | *previous_state = response->previous_state; |
| 2945 | *aux_state = response->aux_state; |
| 2946 | *aux_state_status = response->aux_state_status; |
| 2947 | *progress_percent = response->progress_percent; |
| 2948 | *reason_code = response->reason_code; |
| 2949 | update_option_flags_enabled->value = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 2950 | le32toh(response->update_option_flags_enabled.value); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2951 | |
| 2952 | return PLDM_SUCCESS; |
| 2953 | } |
| 2954 | |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2955 | LIBPLDM_ABI_TESTING |
| 2956 | int encode_get_status_resp(uint8_t instance_id, |
| 2957 | const struct pldm_get_status_resp *status, |
| 2958 | struct pldm_msg *msg, size_t *payload_length) |
| 2959 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 2960 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2961 | int rc; |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2962 | |
| 2963 | if (status == NULL || msg == NULL || payload_length == NULL) { |
| 2964 | return -EINVAL; |
| 2965 | } |
| 2966 | |
| 2967 | if (status->completion_code != PLDM_SUCCESS) { |
| 2968 | return -EINVAL; |
| 2969 | } |
| 2970 | |
| 2971 | rc = encode_pldm_header_only(PLDM_RESPONSE, instance_id, PLDM_FWUP, |
| 2972 | PLDM_GET_STATUS, msg); |
| 2973 | if (rc) { |
| 2974 | return -EINVAL; |
| 2975 | } |
| 2976 | |
| 2977 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, *payload_length); |
| 2978 | if (rc) { |
| 2979 | return rc; |
| 2980 | } |
| 2981 | |
| 2982 | pldm_msgbuf_insert_uint8(buf, PLDM_SUCCESS); |
| 2983 | pldm_msgbuf_insert(buf, status->current_state); |
| 2984 | pldm_msgbuf_insert(buf, status->previous_state); |
| 2985 | pldm_msgbuf_insert(buf, status->aux_state); |
| 2986 | pldm_msgbuf_insert(buf, status->aux_state_status); |
| 2987 | pldm_msgbuf_insert(buf, status->progress_percent); |
| 2988 | pldm_msgbuf_insert(buf, status->reason_code); |
| 2989 | pldm_msgbuf_insert(buf, status->update_option_flags_enabled.value); |
| 2990 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 2991 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 2992 | } |
| 2993 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 2994 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 2995 | int encode_cancel_update_component_req(uint8_t instance_id, |
| 2996 | struct pldm_msg *msg, |
| 2997 | size_t payload_length) |
| 2998 | { |
| 2999 | if (msg == NULL) { |
| 3000 | return PLDM_ERROR_INVALID_DATA; |
| 3001 | } |
| 3002 | |
| 3003 | if (payload_length != PLDM_CANCEL_UPDATE_COMPONENT_REQ_BYTES) { |
| 3004 | return PLDM_ERROR_INVALID_LENGTH; |
| 3005 | } |
| 3006 | |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 3007 | struct pldm_header_info header = { 0 }; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 3008 | header.instance = instance_id; |
| 3009 | header.msg_type = PLDM_REQUEST; |
| 3010 | header.pldm_type = PLDM_FWUP; |
| 3011 | header.command = PLDM_CANCEL_UPDATE_COMPONENT; |
| 3012 | uint8_t rc = pack_pldm_header(&header, &(msg->hdr)); |
| 3013 | if (rc) { |
| 3014 | return rc; |
| 3015 | } |
| 3016 | |
| 3017 | return PLDM_SUCCESS; |
| 3018 | } |
| 3019 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 3020 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 3021 | int decode_cancel_update_component_resp(const struct pldm_msg *msg, |
| 3022 | size_t payload_length, |
| 3023 | uint8_t *completion_code) |
| 3024 | { |
| 3025 | if (msg == NULL || completion_code == NULL) { |
| 3026 | return PLDM_ERROR_INVALID_DATA; |
| 3027 | } |
| 3028 | |
| 3029 | if (payload_length != sizeof(*completion_code)) { |
| 3030 | return PLDM_ERROR_INVALID_LENGTH; |
| 3031 | } |
| 3032 | |
| 3033 | *completion_code = msg->payload[0]; |
| 3034 | return PLDM_SUCCESS; |
| 3035 | } |
| 3036 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 3037 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 3038 | int encode_cancel_update_req(uint8_t instance_id, struct pldm_msg *msg, |
| 3039 | size_t payload_length) |
| 3040 | { |
| 3041 | if (msg == NULL) { |
| 3042 | return PLDM_ERROR_INVALID_DATA; |
| 3043 | } |
| 3044 | |
| 3045 | if (payload_length != PLDM_CANCEL_UPDATE_REQ_BYTES) { |
| 3046 | return PLDM_ERROR_INVALID_LENGTH; |
| 3047 | } |
| 3048 | |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 3049 | struct pldm_header_info header = { 0 }; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 3050 | header.instance = instance_id; |
| 3051 | header.msg_type = PLDM_REQUEST; |
| 3052 | header.pldm_type = PLDM_FWUP; |
| 3053 | header.command = PLDM_CANCEL_UPDATE; |
| 3054 | uint8_t rc = pack_pldm_header(&header, &(msg->hdr)); |
| 3055 | if (rc) { |
| 3056 | return rc; |
| 3057 | } |
| 3058 | |
| 3059 | return PLDM_SUCCESS; |
| 3060 | } |
| 3061 | |
Andrew Jeffery | 9d2a1c6 | 2023-06-05 13:02:16 +0930 | [diff] [blame] | 3062 | LIBPLDM_ABI_STABLE |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 3063 | int decode_cancel_update_resp(const struct pldm_msg *msg, size_t payload_length, |
| 3064 | uint8_t *completion_code, |
| 3065 | bool8_t *non_functioning_component_indication, |
| 3066 | bitfield64_t *non_functioning_component_bitmap) |
| 3067 | { |
| 3068 | if (msg == NULL || completion_code == NULL || |
| 3069 | non_functioning_component_indication == NULL || |
| 3070 | non_functioning_component_bitmap == NULL || !payload_length) { |
| 3071 | return PLDM_ERROR_INVALID_DATA; |
| 3072 | } |
| 3073 | |
| 3074 | *completion_code = msg->payload[0]; |
| 3075 | if (*completion_code != PLDM_SUCCESS) { |
| 3076 | return PLDM_SUCCESS; |
| 3077 | } |
| 3078 | |
| 3079 | if (payload_length != sizeof(struct pldm_cancel_update_resp)) { |
| 3080 | return PLDM_ERROR_INVALID_LENGTH; |
| 3081 | } |
| 3082 | struct pldm_cancel_update_resp *response = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 3083 | (struct pldm_cancel_update_resp *)msg->payload; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 3084 | |
| 3085 | if (!is_non_functioning_component_indication_valid( |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 3086 | response->non_functioning_component_indication)) { |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 3087 | return PLDM_ERROR_INVALID_DATA; |
| 3088 | } |
| 3089 | |
| 3090 | *non_functioning_component_indication = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 3091 | response->non_functioning_component_indication; |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 3092 | |
| 3093 | if (*non_functioning_component_indication) { |
| 3094 | non_functioning_component_bitmap->value = |
Andrew Jeffery | 37dd6a3 | 2023-05-12 16:04:06 +0930 | [diff] [blame] | 3095 | le64toh(response->non_functioning_component_bitmap); |
Andrew Jeffery | 9c76679 | 2022-08-10 23:12:49 +0930 | [diff] [blame] | 3096 | } |
| 3097 | |
| 3098 | return PLDM_SUCCESS; |
| 3099 | } |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 3100 | |
| 3101 | LIBPLDM_ABI_TESTING |
| 3102 | int encode_cancel_update_resp(uint8_t instance_id, |
| 3103 | const struct pldm_cancel_update_resp *resp_data, |
| 3104 | struct pldm_msg *msg, size_t *payload_length) |
| 3105 | { |
Andrew Jeffery | a189696 | 2025-03-03 21:41:25 +1030 | [diff] [blame] | 3106 | PLDM_MSGBUF_DEFINE_P(buf); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 3107 | int rc; |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 3108 | |
| 3109 | if (msg == NULL || payload_length == NULL) { |
| 3110 | return -EINVAL; |
| 3111 | } |
| 3112 | |
| 3113 | rc = encode_pldm_header_only(PLDM_RESPONSE, instance_id, PLDM_FWUP, |
| 3114 | PLDM_CANCEL_UPDATE, msg); |
| 3115 | if (rc) { |
| 3116 | return -EINVAL; |
| 3117 | } |
| 3118 | |
| 3119 | rc = pldm_msgbuf_init_errno(buf, 0, msg->payload, *payload_length); |
| 3120 | if (rc) { |
| 3121 | return rc; |
| 3122 | } |
| 3123 | |
| 3124 | pldm_msgbuf_insert_uint8(buf, PLDM_SUCCESS); |
| 3125 | pldm_msgbuf_insert(buf, |
| 3126 | resp_data->non_functioning_component_indication); |
| 3127 | pldm_msgbuf_insert(buf, resp_data->non_functioning_component_bitmap); |
| 3128 | |
Andrew Jeffery | 70d21c9 | 2025-03-05 12:59:42 +1030 | [diff] [blame] | 3129 | return pldm_msgbuf_complete_used(buf, *payload_length, payload_length); |
Matt Johnston | cf9a2df | 2024-11-07 15:29:29 +0800 | [diff] [blame] | 3130 | } |