Release Notes for System Event Log(SEL) Viewer Utility(SELViewer)
Version 14.1 Build 20

July 24, 2018
Copyright (c) 2018 Intel Corporation.
=======================================

Contents
---------

1. Introduction
2. Supported Platforms
3. Supported Operating Systems
4. Pre-requisites
5. Installation and Un-installation
6. Usage
7. Known Issues
8. Unsupported Features
9. Change List
10. Instructions to End User
11. Legal Information

1. Introduction
-----------------
The System Event Log (SEL) viewer utility is used for displaying data from the Integrated BMC's system event log.

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)
   Windows* Server 2016 
   Windows* Server 2012 R2 
   Windows* 10 
   RHEL* 6.8 (x64)
   RHEL* 7.3
   SLES* 11.4 (x64)
   SLES* 12.2
   CentOS* 7.3 (x64)
   Debian* 8.10

4. Pre-requisites 
-----------------
   1. JRE must be installed to support the GUI of SEL Viewer utility. 
      SUN JRE can be downloaded from  
      http://www.java.com/en/download/manual.jsp#lin.
      
   2. On Linux after installing JRE, make sure that java would point 
      to the newly installed JRE. This can be done by creating a soft link
      (Can be created by using "ln -s <JRE_INSTALLATION_DIR>/bin/java /usr/bin/java".
   
      If the soft link already exists, delete the soft link and run the above command) 
      or by adding JRE installation directory to the system path 
      ("export PATH=<JRE_INSTALLATION_DIR>/bin:$PATH") where <JRE_INSTALLATION_DIR> is the 
      path of the directory where JRE is installed.

  
   3. Install JRE X32 version for supporting WinPE 2.0 (32 bit) OS and JRE X64 
      version for supporting WinPE 2.1 (EM64T) OS. Installation of JRE in a USB pen drive should be
      performed on the same version of the operating system i.e. for JRE x32 version use windows 32 bit OS
      and for JRE x64 version use Windows 64 bit OS. 

   4. In Windows/WINPE set the JRE path using "PATH=%PATH%;<>:\bin" (where <> is the USB directory shown on the cmd prompt
      i.e D: or E: etc. or the path where java is installed i.e. c:\Program Files\Java)

   5. While installing JRE on USB pen drive to support WinPE 2.0 and WinPE 2.1 
      change the installation directory USB pen drive (eg g:\).

   6. Install all the development and optional packages during RHEL* and SuSE* Operating system installation. 

   7. On RHEL*, SLES*, CentOS*, UEFI aware Linux or other Linux
      Install necessary libs if the utility fails while loading libs. 
      64 bit libs with "x86_64" suffix for 64 bit binary, 32 bit libs with "i686" suffix for 32 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.
  
   8. On RHEL*, SLES*, CentOS*, UEFI aware Linux or other Linux
      There might be a driver conflict between internal driver and kernel. You need to start up OpenIPMI driver and make sure "/dev/ipmi0" device exists.

      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

   9. Utility works only if it is executed with Administrator privilege on Windows* and with root privilege on Linux* OSes.

5. Installation and Un-installation
-----------------------------------
   Installation:
   ---------------
   a. For 32 bit Windows, go to folder "Windows\x86\imbdriver" and run "install.cmd" as administrator to install ipmi drivers. Run selview.exe as administrator.
   b. For 64 bit Windows and WinPE, go to folder "Windows\x64\imbdriver" and run "install.cmd" as administrator to install ipmi drivers. Run selview.exe as administrator.
   c. For all supported Linux OS versions, the executables can be located in selview.zip in "Linux_x86" or "Linux_x64" folder (based on the operating system). Unzip selview.zip and use "# chmod 755" to change executable and script. Use the executable directly.
   d. For UEFI go to "UEFI_x64" folder and execute the selview.efi in EFI shell. selview_temp.efi is internal temporary file, please do not remove or use it.
   e. Linux*
   
     I. RPM Installation:
        --------------------

        1. Copy selview rpm from "Linux_x86/RPM" or "Linux_x64/RPM" folder to local folder.
        2. If there is another version already has been installed previously, uninstall that version first before installing the new version.
        3. Install selview utility by using "rpm -ivh selviewerxx.rpm". This will install the utility in "/usr/bin/selview/".
        4. On RHEL/SLES after installing the rpm close the terminal from which rpm was installed and then execute utility from a new terminal (example: "# selview").
        
    II. RPM Uninstallation:
        -------------------
        1. To uninstall the utility use "rpm -e selviewer" command.

   III. DEB Installation:
        ---------------------
        1. dpkg -i xxxx.deb

        DEB Uninstallation:
        ---------------------
        1. dpkg -r selviewer

   Un-installation:
   ---------------
    a. Run uninstall.cmd to uninstall all the drivers on Windows OS. 
    b. Manually delete the contents of the directory where the utility is installed for UEFI, Windows and Linux OS.

6. Usage
--------
   The following is the procedure to execute the SEL Viewer utility:

   I. GUI interface
     1. The SEL Viewer is invoked by entering the following command at a command prompt:
        selview

     2. Shortcut keys for the SEL Viewer GUI for Windows and Linux OSes:
        'Alt  + F' to open the File menu
        'Alt  + S' to open the SEL menu
        'Alt  + V' to open the View menu
        'Alt  + H' to open the Help menu
        'Ctrl + S' to save the SEL entries to a file
        'Ctrl + O' to open a saved SEL file
        'Ctrl + Q' to exit the SEL Viewer GUI
        'Ctrl + R' to reload the SEL entries from the system
        'Ctrl + P' to View the properties window
        'Ctrl + K' to clear SEL
        'Ctrl + G' to go to a particular SEL record.
        'Alt  + V' followed by 'D' to Display in Hex
        'Alt  + V' followed by 'T' to Display in Text
        'Alt  + H' followed by 'A' to view the about window
        'F1' for General Help

    3. Run the following command in EFI shell before running the SEL Viewer application:
    mode 100 31       

   II. Command-line interface

      The SEL Viewer can be run as a command-line application for some of the actions that
      it performs, including clearing the SEL or saving SEL contents to a file.

        selview <switch> [SEL File Name] 

      a. To view the command-line help:
                selview /h or 
                selview /?  

      b. To clear the SEL entries:
                selview /clear

      c. To save the SEL entries to a file in hex format:
                selview hexlog.sel /save /hex or
                selview /save /hex hexlog.sel

      d. To save the SEL entries to a file in text format:
                selview textlog.sel /save or
                selview /save textlog.sel

* In place of '/', user can use '-' also.
* command line switches are case insensitive.

7. Known Issues
---------------
   Utility
   -------
   1. In UEFI GUI switching between the Menu and other windows (main window and SEL info window), the file menu is always seen highlighted.
   2. In UEFI if the SEL description in the information pane exceeds 250 characters then the heading for Generator ID will be missing in the UI. 
   3. Utilities, SNMP-SA and IASC cannot run at the same time due to KCS port conflict. There will be error message
      "Error: Application Cannot Communicate to the BMC.".
   4. 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.
   5. <Home> and <End> keys are not supported to scroll around the UEFI GUI display pane.
   6. Running Selviewer UEFI GUI from root directory of any drive is not supported.
   7. Debian OS does 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.

8. Unsupported Features
------------------------
   Utility cannot be executed successfully when UEFI secure boot is enabled under Linux because Linux closes all IO port access when UEFI secure boot is enabled. If customer wants to use it under Linux environment, please ensure UEFI secure boot is disabled in BIOS F2 menu. 

9. Change List
------------------------
   Build 20
   Rebuild for Windows

   Build 19
   Add deb package for Debian

   Build 18
   Change DIMM index from 0-based to 1-based

   Build 17
   Support new SKU

   Build 16
   Fix SEL translation from System Firmware Progress sensors

   Build 15
   Support FPGA-relative SEL translation

   Build 14
   Support new BMC version format in SEL

   Build 13
   Support new SKU
   Fix a SEL translation defect for "AutoCfg Status".

   Build 12
   Support new SKU

   Build 11
   Fix SEL severity mismatch issue for "SPS FW Health"
   Fix exception hang issue under EFI shell

   Build 10
   Fix SEL translation defect for DIMM location

   Build 9 
   a. Fix SEL translation typo of "PCI Express Bad TLP"
   b. Use 1 byte GID for SEL translation

   Build 8
   a. Fix GUI hang issue in UEFI shell
   b. Support SSB thermal trip SEL

   Build 7
   a. Support a new SKU
   b. Update supported OS list 

   Build 6
   Fix a defect about SEL full warning message in Selviewer GUI.

10. Instructions to End User
---------------------------
   a. System needs to be updated with appropriate FRUSDR package.
   b. One needs to ensure that read-only attribute is disabled for SEL Viewer  
      utility's release folders before running SEL Viewer utility application. 
      If the release folders are read-only, user needs to disable the read-only  
      attribute of all the inner folders and all the files in the release folder,
      except for ReleaseNotes.txt file.

      If still user couldn't able to save the SEL entries to a file, it is wise  
      to do the following:
        a. Create a directory on your USB key or external hard disk,
        b. Copy SEL Viewer release files to the above created directory.
        c. Ensure that all the files are available in the folder.
        d. Run SEL Viewer application.

   c. Do not edit or delete or rename the SelView.bat, OpenSave.exe Selview.sh and Selview_gui.efi file from the installed
     folder doing so will fail to launch the GUI and some GUI features.

   d. User cannot save the SEL entries to a file if the SEL Viewer application is running from CD ROM.

11. 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) 2018 Intel Corporation.



(end)

