1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) 2018-2019, Intel Corporation. */
4 #include <asm/unaligned.h>
5 #include <linux/uuid.h>
6 #include <linux/crc32.h>
7 #include <linux/pldmfw.h>
9 #include "ice_fw_update.h"
12 struct pldmfw context;
15 struct netlink_ext_ack *extack;
17 /* Track which NVM banks to activate at the end of the update */
22 * ice_send_package_data - Send record package data to firmware
23 * @context: PLDM fw update structure
24 * @data: pointer to the package data
25 * @length: length of the package data
27 * Send a copy of the package data associated with the PLDM record matching
28 * this device to the firmware.
30 * Note that this function sends an AdminQ command that will fail unless the
31 * NVM resource has been acquired.
33 * Returns: zero on success, or a negative error code on failure.
36 ice_send_package_data(struct pldmfw *context, const u8 *data, u16 length)
38 struct ice_fwu_priv *priv = container_of(context, struct ice_fwu_priv, context);
39 struct netlink_ext_ack *extack = priv->extack;
40 struct device *dev = context->dev;
41 struct ice_pf *pf = priv->pf;
42 struct ice_hw *hw = &pf->hw;
43 enum ice_status status;
46 package_data = kmemdup(data, length, GFP_KERNEL);
50 status = ice_nvm_set_pkg_data(hw, false, package_data, length, NULL);
55 dev_err(dev, "Failed to send record package data to firmware, err %s aq_err %s\n",
57 ice_aq_str(hw->adminq.sq_last_status));
58 NL_SET_ERR_MSG_MOD(extack, "Failed to record package data to firmware");
66 * ice_check_component_response - Report firmware response to a component
67 * @pf: device private data structure
68 * @id: component id being checked
69 * @response: indicates whether this component can be updated
70 * @code: code indicating reason for response
71 * @extack: netlink extended ACK structure
73 * Check whether firmware indicates if this component can be updated. Report
74 * a suitable error message over the netlink extended ACK if the component
77 * Returns: zero if the component can be updated, or -ECANCELED of the
78 * firmware indicates the component cannot be updated.
81 ice_check_component_response(struct ice_pf *pf, u16 id, u8 response, u8 code,
82 struct netlink_ext_ack *extack)
84 struct device *dev = ice_pf_to_dev(pf);
85 const char *component;
88 case NVM_COMP_ID_OROM:
89 component = "fw.undi";
92 component = "fw.mgmt";
94 case NVM_COMP_ID_NETLIST:
95 component = "fw.netlist";
98 WARN(1, "Unexpected unknown component identifier 0x%02x", id);
102 dev_dbg(dev, "%s: firmware response 0x%x, code 0x%x\n",
103 component, response, code);
106 case ICE_AQ_NVM_PASS_COMP_CAN_BE_UPDATED:
107 /* firmware indicated this update is good to proceed */
109 case ICE_AQ_NVM_PASS_COMP_CAN_MAY_BE_UPDATEABLE:
110 dev_warn(dev, "firmware recommends not updating %s, as it may result in a downgrade. continuing anyways\n", component);
112 case ICE_AQ_NVM_PASS_COMP_CAN_NOT_BE_UPDATED:
113 dev_info(dev, "firmware has rejected updating %s\n", component);
118 case ICE_AQ_NVM_PASS_COMP_STAMP_IDENTICAL_CODE:
119 dev_err(dev, "Component comparison stamp for %s is identical to the running image\n",
121 NL_SET_ERR_MSG_MOD(extack, "Component comparison stamp is identical to running image");
123 case ICE_AQ_NVM_PASS_COMP_STAMP_LOWER:
124 dev_err(dev, "Component comparison stamp for %s is lower than the running image\n",
126 NL_SET_ERR_MSG_MOD(extack, "Component comparison stamp is lower than running image");
128 case ICE_AQ_NVM_PASS_COMP_INVALID_STAMP_CODE:
129 dev_err(dev, "Component comparison stamp for %s is invalid\n",
131 NL_SET_ERR_MSG_MOD(extack, "Component comparison stamp is invalid");
133 case ICE_AQ_NVM_PASS_COMP_CONFLICT_CODE:
134 dev_err(dev, "%s conflicts with a previous component table\n",
136 NL_SET_ERR_MSG_MOD(extack, "Component table conflict occurred");
138 case ICE_AQ_NVM_PASS_COMP_PRE_REQ_NOT_MET_CODE:
139 dev_err(dev, "Pre-requisites for component %s have not been met\n",
141 NL_SET_ERR_MSG_MOD(extack, "Component pre-requisites not met");
143 case ICE_AQ_NVM_PASS_COMP_NOT_SUPPORTED_CODE:
144 dev_err(dev, "%s is not a supported component\n",
146 NL_SET_ERR_MSG_MOD(extack, "Component not supported");
148 case ICE_AQ_NVM_PASS_COMP_CANNOT_DOWNGRADE_CODE:
149 dev_err(dev, "Security restrictions prevent %s from being downgraded\n",
151 NL_SET_ERR_MSG_MOD(extack, "Component cannot be downgraded");
153 case ICE_AQ_NVM_PASS_COMP_INCOMPLETE_IMAGE_CODE:
154 dev_err(dev, "Received an incomplete component image for %s\n",
156 NL_SET_ERR_MSG_MOD(extack, "Incomplete component image");
158 case ICE_AQ_NVM_PASS_COMP_VER_STR_IDENTICAL_CODE:
159 dev_err(dev, "Component version for %s is identical to the running image\n",
161 NL_SET_ERR_MSG_MOD(extack, "Component version is identical to running image");
163 case ICE_AQ_NVM_PASS_COMP_VER_STR_LOWER_CODE:
164 dev_err(dev, "Component version for %s is lower than the running image\n",
166 NL_SET_ERR_MSG_MOD(extack, "Component version is lower than the running image");
169 dev_err(dev, "Unexpected response code 0x02%x for %s\n",
171 NL_SET_ERR_MSG_MOD(extack, "Received unexpected response code from firmware");
179 * ice_send_component_table - Send PLDM component table to firmware
180 * @context: PLDM fw update structure
181 * @component: the component to process
182 * @transfer_flag: relative transfer order of this component
184 * Read relevant data from the component and forward it to the device
185 * firmware. Check the response to determine if the firmware indicates that
186 * the update can proceed.
188 * This function sends AdminQ commands related to the NVM, and assumes that
189 * the NVM resource has been acquired.
191 * Returns: zero on success, or a negative error code on failure.
194 ice_send_component_table(struct pldmfw *context, struct pldmfw_component *component,
197 struct ice_fwu_priv *priv = container_of(context, struct ice_fwu_priv, context);
198 struct netlink_ext_ack *extack = priv->extack;
199 struct ice_aqc_nvm_comp_tbl *comp_tbl;
200 u8 comp_response, comp_response_code;
201 struct device *dev = context->dev;
202 struct ice_pf *pf = priv->pf;
203 struct ice_hw *hw = &pf->hw;
204 enum ice_status status;
207 switch (component->identifier) {
208 case NVM_COMP_ID_OROM:
209 case NVM_COMP_ID_NVM:
210 case NVM_COMP_ID_NETLIST:
213 dev_err(dev, "Unable to update due to a firmware component with unknown ID %u\n",
214 component->identifier);
215 NL_SET_ERR_MSG_MOD(extack, "Unable to update due to unknown firmware component");
219 length = struct_size(comp_tbl, cvs, component->version_len);
220 comp_tbl = kzalloc(length, GFP_KERNEL);
224 comp_tbl->comp_class = cpu_to_le16(component->classification);
225 comp_tbl->comp_id = cpu_to_le16(component->identifier);
226 comp_tbl->comp_class_idx = FWU_COMP_CLASS_IDX_NOT_USE;
227 comp_tbl->comp_cmp_stamp = cpu_to_le32(component->comparison_stamp);
228 comp_tbl->cvs_type = component->version_type;
229 comp_tbl->cvs_len = component->version_len;
230 memcpy(comp_tbl->cvs, component->version_string, component->version_len);
232 status = ice_nvm_pass_component_tbl(hw, (u8 *)comp_tbl, length,
233 transfer_flag, &comp_response,
234 &comp_response_code, NULL);
239 dev_err(dev, "Failed to transfer component table to firmware, err %s aq_err %s\n",
240 ice_stat_str(status),
241 ice_aq_str(hw->adminq.sq_last_status));
242 NL_SET_ERR_MSG_MOD(extack, "Failed to transfer component table to firmware");
246 return ice_check_component_response(pf, component->identifier, comp_response,
247 comp_response_code, extack);
251 * ice_write_one_nvm_block - Write an NVM block and await completion response
252 * @pf: the PF data structure
253 * @module: the module to write to
254 * @offset: offset in bytes
255 * @block_size: size of the block to write, up to 4k
256 * @block: pointer to block of data to write
257 * @last_cmd: whether this is the last command
258 * @extack: netlink extended ACK structure
260 * Write a block of data to a flash module, and await for the completion
261 * response message from firmware.
263 * Note this function assumes the caller has acquired the NVM resource.
265 * Returns: zero on success, or a negative error code on failure.
268 ice_write_one_nvm_block(struct ice_pf *pf, u16 module, u32 offset,
269 u16 block_size, u8 *block, bool last_cmd,
270 struct netlink_ext_ack *extack)
272 u16 completion_module, completion_retval;
273 struct device *dev = ice_pf_to_dev(pf);
274 struct ice_rq_event_info event;
275 struct ice_hw *hw = &pf->hw;
276 enum ice_status status;
277 u32 completion_offset;
280 memset(&event, 0, sizeof(event));
282 status = ice_aq_update_nvm(hw, module, offset, block_size, block,
285 dev_err(dev, "Failed to program flash module 0x%02x at offset %u, err %s aq_err %s\n",
286 module, offset, ice_stat_str(status),
287 ice_aq_str(hw->adminq.sq_last_status));
288 NL_SET_ERR_MSG_MOD(extack, "Failed to program flash module");
292 err = ice_aq_wait_for_event(pf, ice_aqc_opc_nvm_write, HZ, &event);
294 dev_err(dev, "Timed out waiting for firmware write completion for module 0x%02x, err %d\n",
296 NL_SET_ERR_MSG_MOD(extack, "Timed out waiting for firmware");
300 completion_module = le16_to_cpu(event.desc.params.nvm.module_typeid);
301 completion_retval = le16_to_cpu(event.desc.retval);
303 completion_offset = le16_to_cpu(event.desc.params.nvm.offset_low);
304 completion_offset |= event.desc.params.nvm.offset_high << 16;
306 if (completion_module != module) {
307 dev_err(dev, "Unexpected module_typeid in write completion: got 0x%x, expected 0x%x\n",
308 completion_module, module);
309 NL_SET_ERR_MSG_MOD(extack, "Unexpected firmware response");
313 if (completion_offset != offset) {
314 dev_err(dev, "Unexpected offset in write completion: got %u, expected %u\n",
315 completion_offset, offset);
316 NL_SET_ERR_MSG_MOD(extack, "Unexpected firmware response");
320 if (completion_retval) {
321 dev_err(dev, "Firmware failed to program flash module 0x%02x at offset %u, completion err %s\n",
323 ice_aq_str((enum ice_aq_err)completion_retval));
324 NL_SET_ERR_MSG_MOD(extack, "Firmware failed to program flash module");
332 * ice_write_nvm_module - Write data to an NVM module
333 * @pf: the PF driver structure
334 * @module: the module id to program
335 * @component: the name of the component being updated
336 * @image: buffer of image data to write to the NVM
337 * @length: length of the buffer
338 * @extack: netlink extended ACK structure
340 * Loop over the data for a given NVM module and program it in 4 Kb
341 * blocks. Notify devlink core of progress after each block is programmed.
342 * Loops over a block of data and programs the NVM in 4k block chunks.
344 * Note this function assumes the caller has acquired the NVM resource.
346 * Returns: zero on success, or a negative error code on failure.
349 ice_write_nvm_module(struct ice_pf *pf, u16 module, const char *component,
350 const u8 *image, u32 length,
351 struct netlink_ext_ack *extack)
353 struct devlink *devlink;
359 devlink = priv_to_devlink(pf);
361 devlink_flash_update_status_notify(devlink, "Flashing",
362 component, 0, length);
364 block = kzalloc(ICE_AQ_MAX_BUF_LEN, GFP_KERNEL);
371 block_size = min_t(u32, ICE_AQ_MAX_BUF_LEN, length - offset);
372 last_cmd = !(offset + block_size < length);
374 /* ice_aq_update_nvm may copy the firmware response into the
375 * buffer, so we must make a copy since the source data is
378 memcpy(block, image + offset, block_size);
380 err = ice_write_one_nvm_block(pf, module, offset, block_size,
381 block, last_cmd, extack);
385 offset += block_size;
387 devlink_flash_update_status_notify(devlink, "Flashing",
388 component, offset, length);
392 devlink_flash_update_status_notify(devlink, "Flashing failed",
393 component, length, length);
395 devlink_flash_update_status_notify(devlink, "Flashing done",
396 component, length, length);
403 * ice_erase_nvm_module - Erase an NVM module and await firmware completion
404 * @pf: the PF data structure
405 * @module: the module to erase
406 * @component: name of the component being updated
407 * @extack: netlink extended ACK structure
409 * Erase the inactive NVM bank associated with this module, and await for
410 * a completion response message from firmware.
412 * Note this function assumes the caller has acquired the NVM resource.
414 * Returns: zero on success, or a negative error code on failure.
417 ice_erase_nvm_module(struct ice_pf *pf, u16 module, const char *component,
418 struct netlink_ext_ack *extack)
420 u16 completion_module, completion_retval;
421 struct device *dev = ice_pf_to_dev(pf);
422 struct ice_rq_event_info event;
423 struct ice_hw *hw = &pf->hw;
424 struct devlink *devlink;
425 enum ice_status status;
428 memset(&event, 0, sizeof(event));
430 devlink = priv_to_devlink(pf);
432 devlink_flash_update_status_notify(devlink, "Erasing", component, 0, 0);
434 status = ice_aq_erase_nvm(hw, module, NULL);
436 dev_err(dev, "Failed to erase %s (module 0x%02x), err %s aq_err %s\n",
437 component, module, ice_stat_str(status),
438 ice_aq_str(hw->adminq.sq_last_status));
439 NL_SET_ERR_MSG_MOD(extack, "Failed to erase flash module");
441 goto out_notify_devlink;
444 /* Yes, this really can take minutes to complete */
445 err = ice_aq_wait_for_event(pf, ice_aqc_opc_nvm_erase, 300 * HZ, &event);
447 dev_err(dev, "Timed out waiting for firmware to respond with erase completion for %s (module 0x%02x), err %d\n",
448 component, module, err);
449 NL_SET_ERR_MSG_MOD(extack, "Timed out waiting for firmware");
450 goto out_notify_devlink;
453 completion_module = le16_to_cpu(event.desc.params.nvm.module_typeid);
454 completion_retval = le16_to_cpu(event.desc.retval);
456 if (completion_module != module) {
457 dev_err(dev, "Unexpected module_typeid in erase completion for %s: got 0x%x, expected 0x%x\n",
458 component, completion_module, module);
459 NL_SET_ERR_MSG_MOD(extack, "Unexpected firmware response");
461 goto out_notify_devlink;
464 if (completion_retval) {
465 dev_err(dev, "Firmware failed to erase %s (module 0x02%x), aq_err %s\n",
467 ice_aq_str((enum ice_aq_err)completion_retval));
468 NL_SET_ERR_MSG_MOD(extack, "Firmware failed to erase flash");
470 goto out_notify_devlink;
475 devlink_flash_update_status_notify(devlink, "Erasing failed",
478 devlink_flash_update_status_notify(devlink, "Erasing done",
485 * ice_switch_flash_banks - Tell firmware to switch NVM banks
486 * @pf: Pointer to the PF data structure
487 * @activate_flags: flags used for the activation command
488 * @extack: netlink extended ACK structure
490 * Notify firmware to activate the newly written flash banks, and wait for the
493 * Returns: zero on success or an error code on failure.
495 static int ice_switch_flash_banks(struct ice_pf *pf, u8 activate_flags,
496 struct netlink_ext_ack *extack)
498 struct device *dev = ice_pf_to_dev(pf);
499 struct ice_rq_event_info event;
500 struct ice_hw *hw = &pf->hw;
501 enum ice_status status;
502 u16 completion_retval;
505 memset(&event, 0, sizeof(event));
507 status = ice_nvm_write_activate(hw, activate_flags);
509 dev_err(dev, "Failed to switch active flash banks, err %s aq_err %s\n",
510 ice_stat_str(status),
511 ice_aq_str(hw->adminq.sq_last_status));
512 NL_SET_ERR_MSG_MOD(extack, "Failed to switch active flash banks");
516 err = ice_aq_wait_for_event(pf, ice_aqc_opc_nvm_write_activate, HZ,
519 dev_err(dev, "Timed out waiting for firmware to switch active flash banks, err %d\n",
521 NL_SET_ERR_MSG_MOD(extack, "Timed out waiting for firmware");
525 completion_retval = le16_to_cpu(event.desc.retval);
526 if (completion_retval) {
527 dev_err(dev, "Firmware failed to switch active flash banks aq_err %s\n",
528 ice_aq_str((enum ice_aq_err)completion_retval));
529 NL_SET_ERR_MSG_MOD(extack, "Firmware failed to switch active flash banks");
537 * ice_flash_component - Flash a component of the NVM
538 * @context: PLDM fw update structure
539 * @component: the component table to program
541 * Program the flash contents for a given component. First, determine the
542 * module id. Then, erase the secondary bank for this module. Finally, write
543 * the contents of the component to the NVM.
545 * Note this function assumes the caller has acquired the NVM resource.
547 * Returns: zero on success, or a negative error code on failure.
550 ice_flash_component(struct pldmfw *context, struct pldmfw_component *component)
552 struct ice_fwu_priv *priv = container_of(context, struct ice_fwu_priv, context);
553 struct netlink_ext_ack *extack = priv->extack;
554 struct ice_pf *pf = priv->pf;
560 switch (component->identifier) {
561 case NVM_COMP_ID_OROM:
562 module = ICE_SR_1ST_OROM_BANK_PTR;
563 flag = ICE_AQC_NVM_ACTIV_SEL_OROM;
566 case NVM_COMP_ID_NVM:
567 module = ICE_SR_1ST_NVM_BANK_PTR;
568 flag = ICE_AQC_NVM_ACTIV_SEL_NVM;
571 case NVM_COMP_ID_NETLIST:
572 module = ICE_SR_NETLIST_BANK_PTR;
573 flag = ICE_AQC_NVM_ACTIV_SEL_NETLIST;
577 /* This should not trigger, since we check the id before
578 * sending the component table to firmware.
580 WARN(1, "Unexpected unknown component identifier 0x%02x",
581 component->identifier);
585 /* Mark this component for activating at the end */
586 priv->activate_flags |= flag;
588 err = ice_erase_nvm_module(pf, module, name, extack);
592 return ice_write_nvm_module(pf, module, name, component->component_data,
593 component->component_size, extack);
597 * ice_finalize_update - Perform last steps to complete device update
598 * @context: PLDM fw update structure
600 * Called as the last step of the update process. Complete the update by
601 * telling the firmware to switch active banks, and perform a reset of
604 * Returns: 0 on success, or an error code on failure.
606 static int ice_finalize_update(struct pldmfw *context)
608 struct ice_fwu_priv *priv = container_of(context, struct ice_fwu_priv, context);
609 struct netlink_ext_ack *extack = priv->extack;
610 struct ice_pf *pf = priv->pf;
613 /* Finally, notify firmware to activate the written NVM banks */
614 err = ice_switch_flash_banks(pf, priv->activate_flags, extack);
621 static const struct pldmfw_ops ice_fwu_ops = {
622 .match_record = &pldmfw_op_pci_match_record,
623 .send_package_data = &ice_send_package_data,
624 .send_component_table = &ice_send_component_table,
625 .flash_component = &ice_flash_component,
626 .finalize_update = &ice_finalize_update,
630 * ice_flash_pldm_image - Write a PLDM-formatted firmware image to the device
631 * @pf: private device driver structure
632 * @fw: firmware object pointing to the relevant firmware file
633 * @extack: netlink extended ACK structure
635 * Parse the data for a given firmware file, verifying that it is a valid PLDM
636 * formatted image that matches this device.
638 * Extract the device record Package Data and Component Tables and send them
639 * to the firmware. Extract and write the flash data for each of the three
640 * main flash components, "fw.mgmt", "fw.undi", and "fw.netlist". Notify
641 * firmware once the data is written to the inactive banks.
643 * Returns: zero on success or a negative error code on failure.
645 int ice_flash_pldm_image(struct ice_pf *pf, const struct firmware *fw,
646 struct netlink_ext_ack *extack)
648 struct device *dev = ice_pf_to_dev(pf);
649 struct ice_hw *hw = &pf->hw;
650 struct ice_fwu_priv priv;
651 enum ice_status status;
654 memset(&priv, 0, sizeof(priv));
656 priv.context.ops = &ice_fwu_ops;
657 priv.context.dev = dev;
658 priv.extack = extack;
660 priv.activate_flags = ICE_AQC_NVM_PRESERVE_ALL;
662 status = ice_acquire_nvm(hw, ICE_RES_WRITE);
664 dev_err(dev, "Failed to acquire device flash lock, err %s aq_err %s\n",
665 ice_stat_str(status),
666 ice_aq_str(hw->adminq.sq_last_status));
667 NL_SET_ERR_MSG_MOD(extack, "Failed to acquire device flash lock");
671 err = pldmfw_flash_image(&priv.context, fw);
679 * ice_check_for_pending_update - Check for a pending flash update
680 * @pf: the PF driver structure
681 * @component: if not NULL, the name of the component being updated
682 * @extack: Netlink extended ACK structure
684 * Check whether the device already has a pending flash update. If such an
685 * update is found, cancel it so that the requested update may proceed.
687 * Returns: zero on success, or a negative error code on failure.
689 int ice_check_for_pending_update(struct ice_pf *pf, const char *component,
690 struct netlink_ext_ack *extack)
692 struct devlink *devlink = priv_to_devlink(pf);
693 struct device *dev = ice_pf_to_dev(pf);
694 struct ice_hw_dev_caps *dev_caps;
695 struct ice_hw *hw = &pf->hw;
696 enum ice_status status;
700 dev_caps = kzalloc(sizeof(*dev_caps), GFP_KERNEL);
704 /* Read the most recent device capabilities from firmware. Do not use
705 * the cached values in hw->dev_caps, because the pending update flag
706 * may have changed, e.g. if an update was previously completed and
707 * the system has not yet rebooted.
709 status = ice_discover_dev_caps(hw, dev_caps);
711 NL_SET_ERR_MSG_MOD(extack, "Unable to read device capabilities");
716 if (dev_caps->common_cap.nvm_update_pending_nvm) {
717 dev_info(dev, "The fw.mgmt flash component has a pending update\n");
718 pending |= ICE_AQC_NVM_ACTIV_SEL_NVM;
721 if (dev_caps->common_cap.nvm_update_pending_orom) {
722 dev_info(dev, "The fw.undi flash component has a pending update\n");
723 pending |= ICE_AQC_NVM_ACTIV_SEL_OROM;
726 if (dev_caps->common_cap.nvm_update_pending_netlist) {
727 dev_info(dev, "The fw.netlist flash component has a pending update\n");
728 pending |= ICE_AQC_NVM_ACTIV_SEL_NETLIST;
733 /* If the flash_update request is for a specific component, ignore all
734 * of the other components.
737 if (strcmp(component, "fw.mgmt") == 0)
738 pending &= ICE_AQC_NVM_ACTIV_SEL_NVM;
739 else if (strcmp(component, "fw.undi") == 0)
740 pending &= ICE_AQC_NVM_ACTIV_SEL_OROM;
741 else if (strcmp(component, "fw.netlist") == 0)
742 pending &= ICE_AQC_NVM_ACTIV_SEL_NETLIST;
744 WARN(1, "Unexpected flash component %s", component);
747 /* There is no previous pending update, so this request may continue */
751 /* In order to allow overwriting a previous pending update, notify
752 * firmware to cancel that update by issuing the appropriate command.
754 devlink_flash_update_status_notify(devlink,
755 "Canceling previous pending update",
758 status = ice_acquire_nvm(hw, ICE_RES_WRITE);
760 dev_err(dev, "Failed to acquire device flash lock, err %s aq_err %s\n",
761 ice_stat_str(status),
762 ice_aq_str(hw->adminq.sq_last_status));
763 NL_SET_ERR_MSG_MOD(extack, "Failed to acquire device flash lock");
767 pending |= ICE_AQC_NVM_REVERT_LAST_ACTIV;
768 err = ice_switch_flash_banks(pf, pending, extack);