**********************************************************************
                    Release Notes for 
                 OSA IPMI device driver

   Copyright (c) 2003-2004 OSA Technologies Inc, an Avocent Company
                   All rights reserved.

            Date Created  : October  7, 2003
            Date Modified : July 26, 2005
                               
**********************************************************************

======================================================================
CONTENTS
======================================================================

   1.0 Overview
   2.0 Linux driver installation
   3.0 Windows driver installation
   4.0 Novell Netware driver installation
   5.0 VMware ESX driver installation
   6.0 Change log
   7.0 Web Sites and Support Phone Number
   8.0 Trademarks and Notices
   9.0 Disclaimer

======================================================================
1.0 Overview
======================================================================
  1.1 Driver Version
      
      Windows 2.2.1.1
      SUSE Linux 2.3.2
      Red Hat Linux 2.3.2
      Netware 2.2.1
      VMware ESX 2.3.2
      

  1.2 Supported Operating System
      
      - DOS
      - Microsoft Windows 2000 Server (standard and enterprise edition)
      - Microsoft Windows server 2003 (standard and enterprise edition)
      - Microsoft Windows server 2003 x64 Edition (standard and enterprise edition)
      - 32bit RedHat Enterprise Linux 2.1 AS
      - 32bit RedHat Enterprise Linux 3 AS/WS/ES
      - 64bit RedHat Enterprise Linux 3 AS for EM64T and AMD64
      - 32bit RedHat Enterprise Linux 4 AS/WS/ES
      - 64bit RedHat Enterprise Linux 4 AS/WS/ES
      - 32bit SUSE Linux 8.2
      - 64bit SUSE Linux 8.2 for AMD Opteron
      - 32bit SUSE Linux Enterprise Server 8.0
      - 64bit SUSE Linux Enterprise Server 8.0 for AMD Opteron
      - 64bit SUSE Linux Enterprise Server 9.0 for EM64T and AMD64
      - Novell Netware 6.5
      - VMware ESX 2.5
      - VMware ESX 2.5.1
      

  1.3 Known Issues
      
      1) While installing the driver rpm on 32bit and AMD64bit version of
         SUSE Linux Enterprise Server (SLES) 8.0, you will get the error message
         of running kernel configuration is different from the kernel source
         configuration and thus the driver installation is failing.
        
         [Solution]
         Basically the SLES8.0 running kernel is 2.4.19-64GB-SMP, but the
         kernel source code is configured for 2.4.19-4GB by default which
         doesn't have symmetric multi-processing support turned on and
         High Memory Support is set to 4GB instead of 64GB.
      
         Here are the steps to fix this problem.
         - Run 'rpm -e osa_ipmi' to uninstall OSA IPMI device driver
         - Change directory to the Linux kernel source top directory, e.g.
           /usr/src/Linux.  
         - Type 'make menuconfig'
         - Set the "symmetric multi-processing support" option on under 
           "Processor type and features".
         - Set "High Memory Support" to 64GB under "Processor Type and features"
         - Save the setting before exit.
         - Run 'make dep' to update kernel source
         - Re-install the OSA IPMI device driver
      
      2) The following message appears while trying to install the osa_ipmidrvr module:
      
         Warning: loading /lib/modules/2.4.19-SMP/misc/osa_ipmidrvr.o will taint the
         kernel: non-GPL license - Proprietary.  Copyright 2003-2004 OSA Technologies Inc.,
         an Avocent Company, San Jose, USA.   See http://www.tux.org/lkml/#export-tainted
         for information about tainted modules
         Module osa_ipmidrvr loaded, with warnings
      
         OSA IPMI device driver is covered under OSA End User License Agreement(
         OSA_EULA.txt) and the shim layer (shimOS.c) which we provide source code along
         with the package is also covered by (OSA_EULA.txt). Please review the OSA_EULA.txt
         under /usr/osa/osa_ipmi-2.2.1-1 directory.  If you don't accept the agreement or
         you are not covered by this agreement, please uninstall the OSA IPMI device driver
         package.
      
         This warning message should appear whenever the OSA IPMI device driver is loaded.
         The warning indicates that our IPMI driver module is not governed by the GPL
         license - it is not open source.  It is covered by OSA End User License
         Agreement (EULA).  In all other respects the driver should work as expected on your
         system. This warning message should have NO impact on performance or functionality
         of our driver.
      
      3) For the users working on 32bit SUSE 8.2 whose gcc version is
         3.3 20030226 (pre-release) the driver rpm script will complain
         about the gcc version mismatch and refuse to install the driver.
      
         [Solution]
         You can manually add '-f' option to insmod command in 
         /sbin/ipmi_load script to force the kernel to load the ipmi
         driver.  However, be aware that the '-f' option will cause
         tainted kernel warning.
      
      
      
======================================================================
2.0 Linux driver installation
======================================================================

  2.1 Manifest for Linux driver
      
      This package contains the following files.
      
      ipmi-i386-suse.o	    - the 32bit pre-compiled driver core object
                              file for SUSE Linux
      ipmi-i386-suse82.o	  - the 32bit pre-compiled driver core object
                              file for SUSE Linux 8.2
      ipmi-i386-suse8sp3.o  - the 32bit pre-compiled driver core object
                              file for SUSE Linux 8 with Service Pack 3
                              applied
      ipmi-i386-redhat.o  	- the 32bit pre-compiled driver core object
                              file for Redhat Linux
      ipmi-i386-redhatas21.o  - the 32bit pre-compiled driver core object
                                file for Redhat Enterprise Linux 2.1 AS
      ipmi-i386-suse9.o	    - the 32bit pre-compiled driver core object
                              file for SUSE Linux Enterprise Server 9
      ipmi-x86_64-suse82.o	- the 64bit pre-compiled driver core object
                              file for SUSE Linux 8.2
      ipmi-x86_64-suse9.o	  - the 64bit pre-compiled driver core object
                              file for SUSE Linux Enterprise Server 9
      ipmi-x86_64-suse.o  	- the 64bit pre-compiled driver core object
                              file for SUSE Linux
      ipmi-x86_64-redhatup3.o  - the 64bit pre-compiled driver core object
                              file for Redhat Enterprise Linux 3 update 3
      ipmi-x86_64-suse8sp3.o - the 64bit pre-compiled driver core object
                               file for SUSE Linux 8 with Service Pack 3
                               applied
      libraw-i386-suse.so	 - the 32bit IPMI driver library for SUSE Linux
      libraw-i386-redhat.so	- the 32bit IPMI driver library for Redhat Linux
      libraw-i386-suse9.so	- the 32bit IPMI driver library for SUSE Linux
                              Enterprise Server 9
      libraw-x86_64-suse.so - the 64bit IPMI driver library for SUSE Linux
      libraw-x86_64-suse9.so 	- the 64bit IPMI driver library for SUSE Linux
                              Enterprise Server 9
      libraw-x86_64-redhat.so	- the 64bit IPMI driver library for Redhat Linux
      shimOS.c		        - the source of Linux "shim" layer
      make.shim		        - makefile for "shim" layer
      build_osadrv	      - a script to build IPMI 32bit/64bit Linux driver.
      /sbin/ipmi_load   	- a script to load the driver and mknod /dev/ipmi
      /sbin/ipmi_unload 	- a script to unload the driver and remove /dev/ipmi
      README      	      - this file
      
      
  2.2 legal and license information
      
      OSA IPMI driver is written as a kernel loadable module.   It has
      two pieces.  One piece contains a shim layer which deals with 
      all kernel dependencies, e.g. kernel version and configuration for
      UP or SMP etc..  We provide source code for our shim layer.  A second 
      piece is a pre-compiled binary object file ipmi-xxx.o.  It contains 
      proprietary logic for all IPMI implementations. During driver installation, 
      the shim code will be compiled and linked with the pre-compiled 
      ipmi-xxx.o file to generate a final driver module, osa_ipmidrvr.o (or
      osa_ipmidrvr.ko), and install under /lib/modules/kernel-version/misc
      directory.
      
      
  2.3 Driver Building and Installation
      
      To install the driver, launch a Unix shell and type:  
      "rpm -i osa_ipmi-x.x.x-x.i386.rpm", it will build and install the 
      driver module on your system.
      If you want to rebuild the driver, change to /usr/osa/osa_ipmi-x.x.x-x
      and launch a Unix shell and type:  "sh build_osadrv".
      
      Building Environments:
      1) Please install the necessary source code packages on your system.
         Recommended directory: /usr/src;
      2) Make sure you have gcc 3.2 available.  Also remember to upgrade your
         binutils package (for as/ld/nm and company) if necessary.
         
      [Note]
      1) For the users working on 32bit SUSE 8.2 whose gcc version is
         3.3 20030226 (pre-release), insmod does not work without '-f' option.
         Please manually add '-f' option to insmod command in 
         /sbin/ipmi_load script for the force loading.  However, the '-f'
         option will cause tainted kernel warning.
      2) Other gcc version may cause the same problem.
      
      
  2.4 Driver uninstallation
      
      To uninstall the driver, launch a Unix shell and type:
       "rpm -e osa_ipmi-x.x.x-x" or "rpm -e osa_ipmi"
      
      
  2.5 Linux Kernel Upgrade
      
      If you upgrade your Linux kernel, we strongly recommend you to uninstall,
      recompile/re-install the OSA IPMI device driver.  Please refer to above 
      section for building environments and steps to rebuild and install the
      driver.
      
      
  2.6 Loading driver with /sbin/ipmi_load
      
      1) The IPMI device interface can be configured when driver is loaded
         by /sbin/ipmi_load script.  If no parameters are specified, the 
         driver will read SMBIOS record 38 (see Appendix C1 of IPMI 1.5 spec)
         and probe the default interface exists.  You can also override the
         SMBIOS record 38 by providing command line parameters to the 
         ipmi_load script.
         
      2) The explanation of three configuration parameters,
         Configuration_Interface : specifies BMC system interface type.
                                   Currently only KCS interface is supported.
                                   1 - KCS 
                                   2 - SMIC 
                                   3 - BT
         baseAddress : specifies the base address of the BMC system interface.
         RegSpacing	 : specifies how the system interface registers are
                       aligned.  See Appendix C1 Table C-1 of the IPMI Spec.
                         0 - ByteBoundary
                         1 - ThirtyTwoBitBoundary
                         2 -  SixteenByteBoundary
         IOMap	 : specifies the type of base address
                         0 - base address mem-mapped, 
                         1 - base address IO-mapped
      3) You must specify all of the three parameters, or nothing to input.
         For example,
         valid formats:
         	   "/sbin/ipmi_load 1 0xca8 1 1"
         	   "/sbin/ipmi_load"
         invalid format:
         	   "/sbin/ipmi_load 1"
         	   "/sbin/ipmi_load 1, 0xca8" 
         	   
      4) If you need different parameters from defaults, you can
         modify the ipmi_load line in /etc/rc.d/rc.local.  For
         SUSE users, modify /etc/init.d/boot.local file instead.
      
      
  2.7 Unloading driver with /sbin/ipmi_unload
      
      To manually unload the ipmi driver, run '/sbin/ipmi_unload'
      from Unix shell.

   	   
======================================================================
3.0 Windows driver installation
======================================================================
  
  To install OSA IPMI KCS driver for Microsoft
  Windows 2000 server or Windows server 2003,
  simply run the setup.exe.
  
  During installation, you will be prompted
  if you want to specify the BMC KCS address
  manually or using SMBIOS record 38.  For all
  IBM X series servers, we highly recommend you
  select the No button which will let the driver
  query SMBIOS record 38 for device driver
  parameters.  Manually setting the parameters
  should only be used for advanced users.  
  Warning: If you manually set an invalid parameter,
  you may cause the OS to blue screen or reboot!
  
  
  3.1 unattended installation
  
      step 1, create a response file. 
              From a CMD shell, cd to where driver setup.exe 
              resides and run 'setup.exe /r /f1"c:\temp\ipmi.iss"'. 
              Be careful, there is no space between /f1 and the
              following quote! This launches a driver installation
              session as well as records your responses for each 
              screen and save it under c:\temp\ipmi.iss.
      
      step 2, invoke silent installation with the response file. 
              You can modify the response file content afterwards
              if you wish. From a CMD shell execute 
              'setup.exe /s /v"/qn" /f1"c:\temp\ipmi.iss".
  
  
======================================================================
4.0 Novell Netware driver installation
======================================================================
  
  To install OSA IPMI driver on Netware 6.5
  
  1) create a directory under Netware server system 
     directory (e.g. SYS:\SYSTEM\osaipmi).
  
  2) copy all files under NetWare directories to the
     above directory.
     File list:
         intf.ini
         osaipmi.nlm
         osasetup.nlm
         osa_license.txt
         
  3) on Netware server console, run 'osaipmi\osasetup -i'
     to install the driver.  The setup program will copy osaipmi.nlm
     and intf.ini to Netware system directory.  It will also add a
     line "LOAD OSAIPMI.NLM" in SYS:\SYSTEM\autoexec.ncf to 
     automatically load the driver.  The original autoexec.ncf is 
     renamed to autoexec.bak.
  
  4) to verify the driver installation, run 'modules osaipmi' on 
     Netware server console.  It will show the driver version and 
     copyright information on the console.
  
  5) to uninstall OSA IPMI driver, run 'osaipmi\osasetup -u'
     in Netware server console.
  
======================================================================
5.0 VMware ESX driver installation
======================================================================  

  To install OSA IPMI driver on VMware ESX
  
  1) In the LILO Boot Menu, choose "ESX" to boot into VMware ESX Server.
  
  2) Press Alt-F2 to login.
  
  3) Make sure gcc is installed. You can verify this by issuing command
     "rpm -qi gcc". If gcc is not installed, you can find the 
     gcc-2.96-108.7.2.i386.rpm package in VMware ESX CD.
  
  4) Install OSA IPMI driver by typing "rpm -i osa_ipmi-x.x.x-x.i386.rpm", 
     it will build and install the driver module on your system.
     If you want to rebuild the driver, change to /usr/osa/osa_ipmi-x.x.x-x
     and type: "sh build_osadrv".
     
  5) Ignore the warning message (please refer to section 1.3.2), the driver
     should now be functioning.
  
  6) To uninstall the driver, type: 
     "rpm -e osa_ipmi-x.x.x-x" or "rpm -e osa_ipmi".

======================================================================
6.0 Change log
======================================================================
  ----------------------------------------------------------
  Windows 2000 Server and Windws Server 2003
  * version 2.2.1.1 on July-26-2005 *
  - Microsoft signed Windows driver.
 
  ----------------------------------------------------------
  Windows 2000 Server and Windws Server 2003
  * version 2.2.1.1 on June-15-2005 *
  - Modified Windows driver to fix blue screen when miniBMC is disabled by RSA card.
    This version is not yet WHQLed.
  
  Netware
  * version 2.2.1 on June-15-2005 *
  - Fixed incorrect response length when returning non-zero completion code Command.
  
  ----------------------------------------------------------
  Windows 2000 Server and Windws Server 2003
  * version 2.2.1.0 on April-21-2005 *
  - Modified Windows driver installer so that SMBIOS type 38 pop-up 
    window will be the default choice.  Currently user has to enter 'NO'
    instead of 'YES' which is counter-intuitive.
  - Fixed incorrect response length when returning non-zero Command
    Completion Code bug in raw.dll.  Resubmit the driver package and
    obtain ditigally signature from Microsoft WHQL.
  - 64bit device driver support for 
    Microsoft Windows server 2003 x64 Edition 
    
  Linux
  * version 2.3.2 on April-21-2005 *
    - added support for
      32bit RedHat Enterprise Linux 4 AS/WS/ES
      64bit RedHat Enterprise Linux 4 AS/WS/ES
    - fixed system hang on x366(Zeus) during device driver installation.

  VMware 
  * version 2.3.2 on April-21-2005 *
  - support for VMware ESX 2.5  

  ----------------------------------------------------------
  Linux
  * version 2.2.2-1 on Oct-29-2004 *
  - add support for 
    > SUSE Linux Enterprise Server 9 for EM64T/AMD64
    > Red Hat Enterprise Linux 3 AS (update 3) for EM64T/AMD64
  - add support for 32bit user application calling 64bit
    IPMI device driver
  - remove debug message in /var/log/messages while
    connecting to IPMI device driver
    
  ----------------------------------------------------------
  Linux
  * version 2.2.1 on Sep-29-2004 *
  - add explanation of tainted kernel warning messages
    because of proprietary license under known issue section.
  - add support for 32bit RedHat Enterprise Linux 2.1 AS
  - add support for SLES8.0 SP3 (32bit and 64bit)
  - fix build script, build_osadrv, not identifying gcc 
    version 3.x properly
  - remove kernel debug message in /var/log/messages when
    driver module is loaded and unloaded by Linux
  - modify libraw.so to set the response data length to 0
    when the completion code is not 0x00.
  
  ----------------------------------------------------------
  Linux
  * version 2.2.1.0 on Aug-25-2004 *
  - change installation messages
  - add OSA_EULA.txt
  - remove the proprietary statements in the shimOS.c 
  
  Netware
  - renamed Netware installation file from osaipmi_setup.nlm
    to osasetup.nlm to conform to 8.3 naming convention.
  
  ----------------------------------------------------------
  * version 2.2.1.0 on July-29-2004 *
  - added installation and un-installation program
    for Netware driver
  - added end user license agreement during Netware
    driver installation
  - renamed ipmi.nlm to osaipmi.nlm on Netware
  - fixed loading OSA IPMI driver twice on Netware
  - fixed limitations on rspLen <= 128 in sendCommand function.
  - fixed tainted kernel messages during Linux driver installation
  - digitally signed by Microsoft on windows server 2003
    and windows 2000 server
  
  ----------------------------------------------------------
  * version 2.02 for Netware 6.5 on June-02-2004 *
  - new driver support for Netware 6.5
  - added installation and un-installation program
  - added end user license agreement during installation
  - renamed ipmi.nlm to osaipmi.nlm
  - fixed loading OSA IPMI driver twice
  
  ----------------------------------------------------------
  * version 2.2.1 *
  - change driver name from ipmidrvr to osa_ipmidrvr
  - fixed limitations on rspLen <= 128 in sendCommand function.
    This fix is applied on drivers for all supported OS.
  - added rpm source package.
  - fixed tainted kernel messages during Linux driver 
    installation
  - added driver support of 64bit Redhat Enterprise Linux 3
    for AMD Opteron processor
  - added driver support of 64bit Windows Server 2003 for
    AMD Opteron processor
  - included IPMI driver library as part of the Linux driver 
    installation.  The libraw.so will be installed under
    /lib directory.
  - recompile Windows driver with "kernel thread mode" in VC++
  
  ----------------------------------------------------------


======================================================================
7.0 Web Sites and Support Phone Number
======================================================================

  7.1   IBM Support Web Site:
        http://www.pc.ibm.com/support

  7.2   IBM eServer xSeries Web Site:
        http://www.ibm.com/eserver/xseries

  7.3   If you have any questions about this update, or
        problems applying the update, go to the following
        Help Center World Telephone Numbers and URL:
        http://www.pc.ibm.com/qtechinfo/YAST-3P2QYL.html


======================================================================
8.0 Trademarks and Notices
======================================================================

  8.1   The following terms are trademarks of the IBM Corporation
        in the United States or other countries or both:

        -  IBM
        -  xSeries
        -  eServer

  8.2   The following terms are trademarks of the Microsoft 
        Corporation in the United States or other countries or 
        both:

        -  Windows
        -  Windows 2000
        -  Windows Server 2003

  8.3   The following terms are trademarks of the Red Hat Corporation in the
        United States or other countries or both:

        -  Red Hat

  8.4   The following terms are trademarks of SuSE, Inc. in the United States 
        and SuSE AG in Germany or other countries:

        -  SuSE

  8.5   The following terms are trademarks of the Novell Corporation in the
        United States or other countries or both:

        -  Novell
        -  NetWare
  
  8.6   Other company, product and service names may be trademarks or service
        marks of others.


======================================================================
9.0 Disclaimer
======================================================================
  THIS DOCUMENT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
  KIND. IBM DISCLAIMS ALL WARRANTIES, WHETHER EXPRESS OR
  IMPLIED, INCLUDING WITHOUT LIMITATION, THE IMPLIED
  WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE AND
  MERCHANTABILITY WITH RESPECT TO THE INFORMATION IN THIS
  DOCUMENT. BY FURNISHING THIS DOCUMENT, IBM GRANTS NO LICENSES
  TO ANY PATENTS OR COPYRIGHTS.
<END>

