Release Note for System Event Log (SEL) Viewer Utility
Version 11.0 Build 10
May 30, 2013

Copyright (c) 2013 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. Unsupported Features.
9. Instructions for end-user.
10. 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 Intel(R) Server Boards
-----------------------------------

   Intel(R) Server Board S1200 series.
   Intel(R) Server Board S1400 series.
   Intel(R) Server Board S1600 series.
   Intel(R) Server Board S2400 series.
   Intel(R) Server Board S2600 series.
   Intel(R) Server Board S4600 series.

3. Supported Operating Systems
-----------------------------
   UEFI 2.0/2.1/2.3.1
   Windows* Server 2008 R2 SP1 x64  
   Windows* Server 2008 SP2 (32 bit & EM64T) 
   Windows* Server 2012 (32 bit & EM64T)
   Windows 7 for Workstation Servers.
   RHEL6* update1/update2/update3/update4 (32 bit & EM64T) 
   SLES* 11  SP1/SP2 (32 bit & EM64T)
   
     
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* 6 update1 OS

      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 install libstdc++-4.4.4-13.el6.i686.rpm and ncurses-libs-5.7-3.20090208.el6.i686.rpm from the OS CD itself using the below commands.
            #rpm -ivh libstdc++-4.4.4-13.el6.i686.rpm
            #rpm -ivh ncurses-libs-5.7-3.20090208.el6.i686.rpm

            example: rpm -ivh media\Packages\libstdc++-4.4.4-13.el6.i686.rpm
                    where CD/DVD is mounted to "media" directory.

      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.
		  
   8. On RHEL* 6 update4 OS
      If the utility fails to display or save SEL entries, 
	  Then start up OpenIPMI driver using the below command. (It will make sure "/dev/ipmi0" device is existed)
         #modprobe ipmi_devintf		  
  
  

5. Installation and Un-installation
-----------------------------------

   Installation:
   ---------------
  
 a. Master SELViewer package "SELViewerVxxx_BuildXX.zip" has all the executables intact with the following folder structure:

      SELViewerVxxx_BuildXX
      
      |------UEFI_x64
      |         |--selview.efi
      |         |--ipmi.efi      
      |         |--hrs_enu.ini
      |         |--selenus.hlp
      |         |--selenus.str
      |         |--SEL.ini 
      |         |--selview_gui.efi
      |         |--NShell.efi
      |         |
      |---Licenses
      |         |--EFIToolKit
      |         |    |--BSD-License-From-Intel.txt
      |         |--Others
      |         |    |--AES-License.txt.txt
      |         |    |--MD5_Message-Digest-License.txt
      |         |    |--SSL Implementation-License.txt
      |         |    |--NetBeansLicense.txt
      |         |----INTEL SOFTWARE LICENSE AGREEMENT WITH.doc
      |         |----license.txt 
      |         |   
      |------Windows
      |         |---x64
      |         |    |--imbdriver
      |         |    |    |--DeviceSetup.exe
      |         |    |    |--imbdrv.cat
      |         |    |    |--IMBDrv.inf
      |         |    |    |--imbdrv.sys
      |         |    |    |--ibsmutil.cat
      |         |    |    |--IBSMUtil.sys
      |         |    |    |--IBSMUx64.inf 
      |         |    |    |--install.cmd
      |         |    |    |--uninstall.cmd
      |         |    |----ui
      |         |    |    |--gui.jar
      |         |    |    |--appframework-1.0.3.jar
      |         |    |    |--beansbinding-1.2.1.jar
      |         |    |    |--swing-worker-1.1.jar
      |         |    |--selview.exe
      |         |    |--selview.bat
      |         |    |--imbapi.dll
      |         |    |--msipmi.dll
      |         |    |--hrs_enu.ini
      |         |    |--OpenSave.exe
      |         |
      |         |---x86
      |         |    |--imbdriver
      |         |    |    |--DeviceSetup.exe
      |         |    |    |--imbdrv.cat
      |         |    |    |--IMBDrv.inf
      |         |    |    |--imbdrv.sys
      |         |    |    |--ibsmutil.cat
      |         |    |    |--IBSMUtil.sys
      |         |    |    |--IBSMUtil.inf
      |         |    |    |--install.cmd
      |         |    |    |--uninstall.cmd
      |         |    |----ui
      |         |    |    |--gui.jar
      |         |    |    |--appframework-1.0.3.jar
      |         |    |    |--beansbinding-1.2.1.jar
      |         |    |    |--swing-worker-1.1.jar
      |         |    |--selview.exe
      |         |    |--selview.bat
      |         |    |--imbapi.dll
      |         |    |--msipmi.dll
      |         |    |--hrs_enu.ini
      |         |    |--OpenSave.exe
      |         |
      |------Linux
      |         |---ui
      |         |    |--gui.jar
      |         |    |--appframework-1.0.3.jar
      |         |    |--beansbinding-1.2.1.jar
      |         |    |--swing-worker-1.1.jar
      |         |--selview.zip
      |         |--Selview.sh      
      
         
   b. For 32 bit windows, go to folder "windows\x86\imbdriver" and run "install.cmd" as administrator to install ipmi driver.
   c. For 64 bit windows, go to folder "windows\x64\imbdriver" and run install.cmd" as administator to install ipmi driver.
   d. For UEFI go to UEFI_x64 and execute the selview.efi in EFI shell.
   f. Linux*
   
   	I. RPM Installation:
     	--------------------
   
        1. Copy selview rpm from Linux/RPM folder local folder.
        2. Install selview utility by using "rpm -Uvh selview-Vxx.x-Bxx.ixxx.rpm". This will install the utility in "/usr/bin/selview/"	
        3. 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").
        
      RPM Uninstallation:
      -------------------
        1. To uninstall the utility use "rpm -e selview" command.


  II. Regular Installation:
      ---------------------

      1. Linux OS version, the executable can be executed directly.

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  + 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 or
                selview hexlog.txt /save /hex or
                selview /save /hex hexlog.txt

      c. To save the SEL entries to a file in text format:

                selview textlog.sel /save or
                selview /save log.sel or
		selview textlog.txt /save or
                selview /save log.txt

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

7. Known Issues
---------------
   
   Utility
   -------
   a. In UEFI GUI switching between the Menu and other windows (main window and SEL info window), the file menu is always seen highlighted.
   b. 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. 

            
8. New/Unsupported Features
------------------------
   New Features
   a. Linux RPM support for selviewer utility.
   b. Windows* Server 2012.
   C. Disable/Enable debug logs.
   d. RHEL6* update3 (32 bit & EM64T)
   e. Saving the Hex and Translated file in '.log' or '.txt' extension 
   
   Unsupported Features
   a. None.
  
9. 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.
   
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) 2013 Intel Corporation.



(end)
