		      Linux System Event Log Viewer - Release Notes
		         Copyright (c) 2007 - 2010, Intel Corporation
			          All Rights Reserved
			            May 21, 2010

The system event log (SEL) viewer utility is a Linux based application program 
used for displaying data from the BMC's system event log.


RELEASE NOTES FOR SEL Viewer VERSION 2.0.1 Build 19

A. SUPPORTED PLATFORMS

     S5500 & S5520 Platform series.
     S3420GP platform series.
     S3420TH platform series.

B. DEPENDENCIES
   
   1. Executes with GUI under the Linux XServer and as a Command Line Interface on Shell.

   2. JRE must be installed. Most of the GNU/Linux distributions come with
      a default JRE installation. It does not support the java UI (Swing) libraries. 
      So a proper SUN JRE must be installed. SUN JRE can be downloaded from 
      http://www.java.com/en/download/manual.jsp#lin. 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. Operating systems supported are: RHEL5.3-32 bit, RHEL5.3-EM64T, RHEL5.4-32 bit, RHEL5.4-EM64T, SLES11-32 bit and SLES11-EM64T.

   4. All the files in the folder should have executable permission.

   
C. CHANGES SINCE THE PREVIOUS RELEASE

   S5500 & S5520 Platform series..
    1. Added support for decoding HDD SEL Errors Under SATA AHCI mode.
    2. Added decoding logic for Memory ECC Error SEL Records.  
      
           
D. Installation Procedure and how to use SEL Viewer utility

The SEL Viewer is meant to be used as an application on a Linux server. 

Now user can run SEL Viewer application either from the USB key or any external 
disk containing SEL Viewer release binaries. Also user can't save the SEL 
entries to a file if the SEL Viewer application is running from CD ROM or if 
the release folders have read-only attribute. User must check this before 
trying save operation.

The following is the procedure to execute the SEL Viewer utility in Linux 
environment:

   1. Command-line interface

      The SEL Viewer can be run either as a GUI based application or a command-line application.
      GUI provides all the functionality as the CLI provides, including clearing the SEL or saving SEL contents to a file.

      ./Selview [Options] [SEL File Name]  or ./cli [Options] [SEL File Name]

      a. To start the SEL Viewer GUI
				
		./Selview

      b. To view the command-line help:

		./Selview /h or ./cli /h

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

		./Selview /save log.sel or ./cli /save log.sel
		
      d. To save the SEL entries to a file in hex format:

		./Selview /save /hex log.sel or ./cli /save /hex log.sel

****Note: 
	End user 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 hrs.ini, selhelp.txt and ReleaseNotes.txt files. 

        If still user couldn't able to save the SEL entries to a file, it is wise to do the following:

	   1. Create a directory on your USB key or external hard disk,
	   2. Copy SEL Viewer release files to the above created directory.
	   3. Ensure that all the files are available in the folder. See section E for reference.
  	   4. Run SEL Viewer application.
********

     e. To clear the SEL entries:

		./Selview /clear or ./cli /clear

* In place of '/', user can use '-' also.

	2. OpenIPMI Driver Usage

          a. By default, if present, the utility will use Open IPMI driver on Linux OS. 
             Utility installation procedure checks for presence of Open IPMI driver and accordingly install Intel drivers.

          b. Steps to start/stop OpenIPMI driver on linux
             1. To start run 'service ipmi start' on linux terminal.
             2. To stop run 'service ipmi stop' on linux terminal.
             3. To view the status of OpenIPMI driver run 'service ipmi status' on linux terminal.

E. Required Files

The SEL Viewer utility should contain the following files and sub directories 
in the directory from which it is running.

	Selview
	cli (command-line version of Selview)
	hrs.ini
	selenus.str
	SELViewer.txt
	ui/gui.jar
	ui/appframework-1.0.3.jar
	ui/beansbinding-1.2.1.jar
	ui/swing-worker-1.1.jar
        Licenses/INTEL SOFTWARE LICENSE AGREEMENT WITH.doc
        Licenses/license.txt
        Licenses/BSD/BSD-License-From-Intel.txt
        Licenses/Others/NetBeansLicense.txt

F. KNOWN ISSUES
      None.

G. UNSUPPORTED FEATURES
      None.

H. INSTRUCTIONS TO END USER

*	The server needs to be updated with the appropriate latest FRUSDR package. 
        The SDR repository is essential in translating SEL entries to a readable SEL description.

*	Do not modify the HRS.ini file.  Any modifications to this file may cause unpredictable behavior of the SEL Viewer utility.  


*	If the SDR record is not found for a SEL event combination (Sensor Type, 
        Generator ID and Sensor number) , the utility will display  sensor type and 
        number instead of the name field, and the SEL Viewer will display sensor reading and threshold reading values as "unspecified".

*	If the SEL Viewer utility cannot find the description string for a SEL 
        event combination (sensor type, offset, evd1, evd2 and evd3), the utility 
        displays the event description for that event as "Unknown Event". 

*	If the event description for the given SEL event is more than 256 characters:
		- Only up to 256 characters will be displayed in the event description 
		  column of the GUI.
		- The bottom window will show the complete event description.

*	The HR_SEL.log file contains the information on Type 02 SEL events that could not be decoded.
        This file is created in the same folder where SEL Viewer application is running.

*	Shortcut keys for the SEL Viewer GUI:

		'Alt-f' followed by 'S' to save the SEL entries to a file
		'Alt-f' followed by 'O' to open a saved SEL file
		'Alt-f' followed by 'x' to exit the SEL Viewer GUI

*	In case of OEM events, Utility decodes events of type C0, C1 and Microsoft OEM events of type 0xDC, 0xDD & 0xDE.

* 	SEL Viewer decodes only the events complying with IPMI 1.5 and 2.0 specifications.

*	Third-party brands and names are the property of their respective owners.


================================================================================

                               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) 2003 - 2010 Intel Corporation.

(end)
