Release Notes for FRU & SDR Load Utility(FRUSDR)
Version 14.1 Build 12

Jan 11, 2018
Copyright (c) 2017 Intel Corporation.
=====================================

Contents
--------

1. Introduction
2. Supported Platforms
3. Supported Operating Systems
4. Pre-requisites
5. Installation and Un-installation (WinPE)
6. Installation and Un-installation (UEFI)
7. Usage
8. Known Issues
9. Unsupported Features
10. Change List
11. Instructions to the end user
12. Legal Information


1. Introduction
---------------
The FRUSDR loader utility is used for updating the FRU (Field Replaceable Unit), SDR (Sensor Data Record) of various micro-controllers on a given platform through the use of platform-specific CFG,FRU and SDR files. The FRUSDR Utility communicates with other controllers on the IPMB. This Utility will display the details of the different areas like SDR Area, FRU Area and SMBIOS Area of the Server.

2. Supported Platforms
----------------------
  Intel(R) Server Board based on Intel(R) Xeon(R) Processor Scalable Performance Family

3. Supported Operating Systems
------------------------------
   UEFI Shell
   WinPE* 4.0 (x64)

4. Pre-requisites
-----------------
   1. Boot to the appropriate WinPE Environment OR EFI shell.

5. Installation and Un-installation (WinPE)
-------------------------------------------
   Installation:
   ------------
     1. Copy the compressed ZIP file into your local directory (e.g. C:\FRUSDR).
     2. Unzip the folder.
     3. There will be ReleaseNotes.txt and folders named "Drivers", "Win_x64".
     4. Go to "Drivers\win\x64" folder and run "install.cmd" as administrator to install drivers.
     5. Go to "Win_x64" folder and you can find frusdr.exe,imbapi.dll and msipmi.dll.

   Uninstallation:
   ---------------
     1. To uninstall FRUSDR loader utility, manually delete the contents of the directory where the utility present.
     2. To uninstall the drivers, please follow this path : "Drivers" -> "win" -> "x64" and run "uninstall.cmd".

6. Installation and Un-installation (UEFI)
-----------------------------------------
   Installation:
   -------------
   1. Unzip the compressed binary image on any Windows* machine and take the folder copy to any external media.
   2. Connect the external media to the machine
   3. Boot system to UEFI and go to the directory where frusdr.efi is present in the external media. frusdr_temp.efi is internal temporary file, please do not remove or use it.
   4. Run frusdr.efi -h for usage.

   Uninstallation:
   ---------------
   1. To uninstall FRUSDR loader utility, manually delete the contents of the directory where the utility is present.

7. Usage
--------
   The following is the procedure to execute the FRUSDR loader utility:
      The FRUSDR loader can be run as a command-line application for the actions that it performs, which includes updating the FRU area and the SDR area of the system and displaying the same on the console. The command switches can be given in any order and the utility will function without any error.

        frusdr <switch> [File Name]

      a. To view the command-line help:
        frusdr /h

      b. Command Line Syntax:
        Usage:  FRUSDR

        /? or /h                  Displays usage information.
        /d {smb,fru,sdr}          Only displays requested area.
        /cfg filename.cfg [/nac]  Uses custom CFG file.

        Note:
        When updating with cfg file, SDR data is, by default, automatically
        configured and updated in BMC, which do not need further user
        interactions. You can disable the default mode and use legacy SDR update
        process with the /nac option.
        In the place of '/', user can use '-' also.


8. Known Issues
---------------
In UEFI, special characters are not allowed for the FRU fields except '-', as the utility might not work with a certain combination of characters. This is due to a limitation from the EFI shell.
In UEFI and WinPE, for customized CFG file update, the tag "@ENVFILE:TYPE:NAME:#" is not supported due to OS limitation.
FRUSDR loader utility will only do "Checksum" calculation for "Common Header" of FRU data.

9. Unsupported Features
------------------------
   None.

10. Change List
------------------------
   Build 12
   Fix "Product Area" update failure when checksum is 0xC1

   Build 11
   Support a new SKU
   Fix a defect about reading FRU with special characters

   Build 10
   Fix the MultiRecord area update issue

   Build 9
   Fix maximum length defect of "BMCCONFIG" command

   Build 8
   Support a new SKU
   Support area checksum generation for FRU update

   Build 7
   Fix exception hang issue under EFI shell
   Fix the defect that asset tag can't be modified
   Support new SKU

   Build 6
   Support reading/writing FRU of PCIe card

   Build 5
   Support a new SKU
   Update supported OS list 

   Build 4
   Support auto detection of FANs

   Build 3
   Add wildcard letter support in *.cfg file

11. Instructions to the end user
-----------------------
 1. The user needs to enable the "Plug and Play BMC" setting in the BIOS, in order to enable the MS IPMI driver in winPE. Otherwise the utility will error out.

 2. When the "Plug and Play BMC" setting is disabled in the F2 screen, the user needs to install the Intel IPMI driver manually using the following command.
    Devicesetup.exe -v install IMBDrv.inf *IMBDRV
    Due to certain limitations from the WinPE OS, MSIPMI driver is shown as detected always, irrespective of the "Plug and Play BMC" status.

12. 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) 2017 Intel Corporation.

(end)

