Release Notes for System Firmware Update Utility(SysFwUpdt) Version 14.2 Build 11 Apr 06, 2021 Copyright (c) 2021 Intel Corporation ============================================ Contents -------- 1. Introduction. 2. Supported Intel(R) Server Boards. 3. Supported Operating Systems. 4. Pre-requisites. 5. Installation and Un-installation. 6. Usage. 7. Known Issues. 8. Change List 9. Instructions for end-user. 10. Legal Information 1. Introduction --------------- The System Firmware Update Utility is a program used for updating the system BIOS, BMC, ME of systems. 2. Supported Intel(R) Server Boards ---------------------- Intel® Server System M50CYP (Coyote Pass) Intel® Server System D50TNP (Tennessee Pass) Intel® Server System D40AMP (American Pass) 3. Supported Operating Systems ------------------------------ UEFI 2.3.1 WinPE* 4.0 (x64) Windows* Server 2019 Windows* Server 2016 Windows* Server 2012 R2 Windows* 10 RHEL* 6.8 (x64) RHEL* 7.3 (x64) RHEL* 7.5 (x64) RHEL* 7.6 (x64) RHEL* 8.0 (x64) SLES* 11.4 (x64) SLES* 12.2 (x64) SLES* 15&Sp1 (x64) CentOS* 7.3 (x64) Debian* 8.10 (x64) 4. Pre-requisites ----------------- 1. Install all the development and optional packages during RHEL* and SuSE* Operating system installation. 2. On RHEL*, SLES*, CentOS*, UEFI aware Linux or other Linux Install necessary libs if the utility fails while loading libs following Linux error message. 64 bit libs with "x86_64" suffix for 64 bit binary. For example: a. If the utility fails with error message "error while loading shared libraries: libncurses.so.5: cannot open shared object file: No such file or directory" Then use "rpm -ivh xxxx.rpm" to install libstdc++ and ncurses rpms from the OS b. If the utility fails with error message "Error: /lib/ld-linux.so.2: Bad ELF interpreter: No such file or directory" This indicates development and optional packages are not installed, please install the necessary packages accordingly. c. If the utility installation fails with error message "depends on libncurses5 (>= 6); however: Version of libncurses5:amd64 on system is 5.9+20140913-1+deb8u2." This indicates libncurses version must be >= 6, please install new libncurses. 3. On RHEL*, SLES*, CentOS*, UEFI aware Linux or other Linux 1. There might be a driver conflict between internal driver and kernel. You need to start up OpenIPMI driver. If the utility fails with any error such as "FW interface failed" when updating BMC or "terminate called after throwing an instance of 'ResultStatus' Aborted (core dumped)" when updating SDR with CFG file, then start up OpenIPMI driver and make sure "/dev/ipmi0" device exists. BMC update cannot continue if OpenIPMI driver is not started. For RHEL* run the below command and make sure "/dev/ipmi0" device exists. #modprobe ipmi_devintf or #modprobe ipmi_si For SLES* run the below command and make sure "/dev/ipmi0" device exists. #service ipmi start 2. After enabling OpenIPMI, if utility still reports errors during BMC, FRU and SDR update, for example "Failed to write SDR file.", "SDR auto-update failed" and "Error : Error while parsing the cfg file", there might be a BMC watch dog conflict with OpenIPMI driver. User needs to disable BMC watch dog, do update and enable it after update is finished. 4. Utility works only if it is executed with Administrator privilege on Windows* and with root privilege on Linux* OSes. 5. Updating of PFR BMC/BIOS/CPLD is not supported by the utility if the BMC Firmware is in Transfer Mode. 6. It's recommended to do a direct FRU update in EFI/WinPE before doing a FRU Resize with customized CFG file. 5. Getting started ----------------------------------- 1. For 32 bit Windows, go to folder "SysFWUpdtxx\Drivers\win\x86" and run "install.cmd" as administrator to install ipmi, smi and memory map drivers. 2. For 64 bit Windows and WinPE, go to folder "SysFWUpdtxx\Drivers\win\x64" and run "install.cmd" as administrator to install ipmi, smi and memory map drivers. 3. For 32 bit Windows, please use sysfwupdt in "SysFWUpdtxx\Win_x86". Run sysfwupdt.exe as administrator. 4. For 64 bit Windows and WinPE, please use sysfwupdt in "SysFWUpdtxx\Win_x64". Run sysfwupdt.exe as administrator. 5. For UEFI shell, please use sysfwupdt.efi in "SysFWUpdtxx\UEFI_x64". And sysfwupdt_core.efi is internal lib file, please do not remove or use it. 6. Linux* I. RPM Installation: -------------------- 1. Copy sysfwupdt rpm from corresponding folder to local folder. -> for RHEL older than 8.0,please copy from Linux_x64\RHEL -> for RHEL8.0 and above,please copy from Linux_x64\RHEL\RHEL8 -> for SLES older than 15,please copy from Linux_x64\SLES -> for SLES15 and above,please copy from Linux_x64\SLES\SLES15 2. If there is another version already has been installed previously, uninstall that version first before installing the new version. 3. Install sysfwupdt utility by using "rpm -ivh sysfwupdtxx.rpm". This will install the utility in "/usr/bin/sysfwupdt/". 4. On RHEL utility can now be executed from any terminal (example: "# sysfwupdt -i"). 5. On SLES after installing the rpm close the terminal from which rpm was installed and then execute utility from a new terminal (example: "# sysfwupdt -i"). RPM Uninstallation: ------------------- 1. To uninstall the utility use "rpm -e sysfwupdt" command. II. Regular Installation: --------------------- 1. Linux OS version, unzip package and use "# chmod 755" to change executable. The executable can be executed directly. III. DEB Installation: --------------------- 1. dpkg -i xxxx.deb DEB Uninstallation: --------------------- 1. dpkg -r sysfwupdt 6. Usage -------- 1. Command line Interface SysFwUpdt Options [File Name] Options: -u: Update BIOS image, BMC image, CPLD image, ITK image and nvram update -i: Display System BIOS, BMC and SDR Information -cfg: Update fru/sdr by cfg file a. To view the command-line help page: SysFwUpdt -h b. To update the BIOS/BMC/CPLD image: SysFwUpdt -u BIOSFileName/BMCFileName/CPLDFileName SysFwUpdt -u BIOSFileName/BMCFileName/CPLDFileName -kcs c. To update the customized EWS image: SysFwUpdt -u EWSFileName d. To update the BIOS, BMC and CPLD image together: SysFwUpdt -u BIOSFileName BMCFileName CPLDFileName e. To update the ITK image: SysFwUpdt -u ITKFileName SysFwUpdt -u ITKFileName Password=xxx f. To update NVRAM SysFwUpdt -u FileName UpdateNvram g. To update BIOS/BMC recovery image SysFwUpdt -u BIOSFileName/BMCFileName -recovery h. To display the system BIOS, BMC and SDR version: SysFwUpdt -i SysFwUpdt -i -u CFGFileName i. To update frusdr SysFwUpdt -cfg cfgFileName j. To restore BIOS setting SysFwUpdt -rd adminpassword k. To display fru, sdr, smbios area SysFwUpdt -d fru/sdr/smb l. To set fru area SysFwUpdt -set FRUAREA/FRUFIELD m. To force update fru area SysFwUpdt -fru FruFileName n. To clear customer setting SysFwUpdt -ccs o. To restore ME config Sysfwupdt -rmec 2. Reboot system after the update/Restore Default BIOS Settings operation is completed. 7. Known Issues --------------- a. When non-auto config is used (SysFwUpdt -cfg cfgFileName -nac), please choose sdr update only b. SDR force update (SysFwUpdt -sdr SDRFileName) is not supported since SDR change the updated mechanism which depend on a tag set from master cfg. c. When update BIOS/BMC/CPLD, there will be no auto-reset. Once you add the parameter"ImmReset", then there will be a immediate reset after the update command. d. IO port access is not allowed in Linux when UEFI secure boot is enabled. Please disable UEFI secure boot in F2 menu before running utility. e. Debian and SLES* 15 OS do not allow IO memory map by default. User needs to add "iomem=relaxed" to grub boot option to enable IO memory map. Otherwise some features may not work. f. Since build 9, Sysfwupdt /u .bin only support to update bios version SE5C6200.86B.0020.P15 and later version onwards g. No unitest done on AMP board since no AMP board available yet h. Please don't do bios and bmc update at the same time in case of using ImmReset option 8. Change List --------------------------- Build 11 1. Fix 16012973525 - Sysfwupdt utility displays incorrect copyright year 2. Fix 2103639096 - [MiTAC][AMP]Cannot online update BMC FW 2.74b 3. Fix 2103638983 - [MiTAC] Online flash A020P17 BIOS with 2.66.DAB52082 BMC, show error message and can't flash. 4. Fix random file not found issue during BMC online update Build 10 1. Add new product ID for American Pass 2. Fix Klocwork issue 3. Fix 16012748373 - Sysfwupdt utility displays incorrect copyright year 4. Revise the display message for bios online update Build 9 1. CCB3327 - sysfwupdt /u bios.bin via SW SMI Build 8 1. 16012271586 - fix bios/bmc update issue when force update jumper is set Build 7 1. 2103634616 - fix bios update issue when BMC force update jumper is set 2. 16011750687 - fix /rmec should show kcs message in restrict mode 3. 16011750285 - fix [RHEL8.2] Observed segmentation fault (core dumped) during FRU Update 4. 2103633941 - fix percentage stop at 94% after update customized PDB FRU completely 5. 1508485399 - add new SMI trigger (0xEF30) per bios requirement 6. 2103634107 - fix Error message by sysfwupdt.efi should modify when PFR provision disble 7. CCB3231 - Limit SVN single downgrade during online update Build 6 1. Support kcs policy control feature 2. Change naming *_temp.efi to *_core.efi Build 5 1. Support CPLD recovery update 2. Set bit 1b by default to enalbe defer reset 3. Increase sleep time to avoid getting device ID before BMC reset Build 4 1. Support SLES15&Sp1 2. Support immediate restart(ImmReset) 3. Support restore default setting (/rd) 4. Support update ITK capsule with parameter "Password=xxx" when admin password is set. Build 3 1. Support clear customer setting 2. Support BMC and BIOS recovery update for PFR Whitely 3. Support NVRAM update for Whitley Build 2 1. Support PFR BMC/BIOS/CPLD active update 2. Support ITK capsule update Build 1 1. First Release 9. Instructions for end-user --------------------------- 1. There will be a BIOS and BMC reset after PFR BMC/BIOS/CPLD online update. Please do not cut off the power supply during the reset. This process will last for about ten minutes. Then you need to press the power on button to start the system, which is the CPLD design. 10. Legal Information -------------------- ======================================================== LEGAL INFORMATION ======================================================== Information in this document is provided in connection with Intel Products and for the purpose of supporting Intel developed server boards and systems. No license, express or implied, by estoppel or otherwise, to any intellectual property rights is granted by this document. Except as provided in Intel's Terms and Conditions of Sale for such products, Intel assumes no liability whatsoever, and Intel disclaims any express or implied warranty, relating to sale and/or use of Intel products including liability or warranties relating to fitness for a particular purpose, merchantability, or infringement of any patent, copyright or other intellectual property right. Intel Corporation may have patents or pending patent applications, trademarks, copyrights, or other intellectual property rights that relate to the presented subject matter. The furnishing of documents and other materials and information does not provide any license, express or implied, by estoppel or otherwise, to any such patents, trademarks, copyrights, or other intellectual property rights. Intel products are not intended for use in medical, life saving, or life sustaining applications. Intel may make changes to specifications and product descriptions at any time, without notice. Intel is a registered trademark of Intel Corporation. *Other names and brands are the property of their respective owners. Copyright (c) 2021 Intel Corporation. (end)