This release note and the software it accompanies it are copyright (c) 2003, Intel Corporation, and may only be installed and used in accordance with the license that accompanies the software.

File name: FreeBSD_DRV_205.zip

Driver version 2.05

This download supports the following Intel(R) Server RAID Controllers:
*SRCS14L


Attention!
===========
This package will copy the FreeBSD Intel RAID driver set to a user specified location. 

This driver has been tested with FreeBSD versions 4.3 and 4.4.


Installation Notes for FreeBSD with Intel Integrated RAID Controllers(IIR)
==========================================================================

Driver Version
--------------
iir.ko : Version 1.01
FreeBSD releases 4.6 and above have the "iir" driver embedded in them.
Please compare the driver version on this media with the one on your
FreeBSD system to determine if you need to upgrade your driver.

Files
-----
iir.ko        IIR Driver module (version 1.1) for FreeBSD 4.x releases
iir-1.1.tgz   Driver and Utilities package:
         	copies iir.c, iir.h, iir_ctrl.c, iir_pci.c to /usr/src/sys/dev/iir
         	copies iir.ko to /
         	copies storcon (an utility to manage the IIR RAID subsystem) to /usr/sbin
         	copies iircfg (a command-line utility to manage the IIR RAID subsystem) to /usr/sbin
                copies srcd (adds SNMP Trap reporting support) to /usr/sbin
                copies srcdconf.sh (Shell script to configure srcd) to /usr/sbin
		copies manual pages for storcon, iircfg and srcd to
/usr/share/man/man8
         	modifies /boot/loader.rc (adds iir.ko)
         	modifies /usr/src/sys/conf/files (adds source files)
        	generates /dev/iir (Special device file for Tools, e.g.: STORCON)
         	generates /usr/src/sys/i386/conf/IIR_KERNEL from GENERIC
         	(with IIR entry)
README.txt    This file

Installation Instructions
-------------------------
Instructions are given below for the following
A. Installing FreeBSD onto a Storage RAID Controller Host Drive
B. Installing "iir-1.1.tgz" IIR Driver and utilities package on a FreeBSD System.
C. Compiling and Statically Linking IIR drivers for the FreeBSD kernel.
D. Troubleshooting.

A.Installing FreeBSD onto a Storage RAID Controller Host Drive
--------------------------------------------------------------

FreeBSD releases 4.6 and above have the "iir" driver embedded in them.
Therefore you do not require the driver disk on this media for the install. 
If the drivers on this media are newer than the ones on the system then you
should update the drivers. Please refer to Step B and C for further instructions.

Note: The following steps are just an example to illustrate a custom install of
FreeBSD on Storage RAID Controllers. For detailed information on installation, 
please refer to the FreeBSD Install Manual.

1. Configure Host Drive
   - Driver currently supports Host Drives 0 to 99
   - There is an own virtual channel for the Host Drives
     (behind the physical channels of the Storage RAID Controller)

2. Boot from the Installation CD
   - Enable CD-ROM Boot within STORCON (if the CDROM drive is connected
     with the Storage RAID Controller)
   - We have tested: FreeBSD 4.4-RELEASE. 
   - When the following message appears:
     "Hit [Enter] to boot immediately, or any other key for command prompt.
      Booting [kernel] in x seconds..."
     press any key, and the "ok" prompt is displayed
   - Type in "load kernel" to load the kernel
   - Type in "load disk1:iir" for 4.x releases 
     to load the driver from floppy disk (disk0 is the CD (Floppy Emulation),
     disk1 the first Floppy (DOS Format))
   - Type "boot" to boot the kernel

3. Kernel Configuration Menu
   - Press ENTER for further boot (If any other driver causes problems during boot
     deactivate it in "Start kernel configuration in full-screen visual mode")
   - Kernel boots and the IIR driver recognizes the Storage RAID Controller
     and Host Drives

4. /stand/sysinstall Main Menu
   - Choose Installation Method (Standard Installation is best)
   - FDISK Partition Menu: e.g.:
      A = Use Entire Disk
      Q = Finish
   - FreeBSD Disklabel Editor: e.g.:
      C = Create
       Setup a Swap Partition (this is necessary!, size depends on memory size,
       100-200MB are normally OK)
      C = Create
       Setup Filesystem(s) (minimum 1 FS required, Mount Point "/")
      Q = Finish
   - Select Installation Contents
   - Select Installation medium (CD-ROM)
   - Start Installation

5. System Console Settings -> enter Yes
   - Select Keymap
   - Select Timezone

6. Reboot 
   - Remove the CD and Floppy from the drives

   Note: Though the OS install is complete; the installer program did not install the
     IIR drivers that we manually loaded in the beginning. This means that the
     bootloader/kernel will be unable to detect IIR Hostdrives and mount the root
     filesystem on a reboot. Thus rendering the system useless. We have two choices:
	a) Use the floppy to manually load IIR drivers at every boot.
	b) or permanently install the IIR driver on the system and make the bootloader
	   aware of it. To follow this approach, do the steps detailed below.
   
7. Boot from the Host Drive
   - Interrupt the boot process and load the driver (see Step 2 above).
     Since there is no CD in the drive, the floppy drive is detected as
     "disk 0". Therefore the command to load the iir driver becomes:
     "load disk0:iir" 
   - Kernel boots, IIR driver detects Host Drives

8. Install the IIR driver package
   - Copy file iir-11.tgz from the floppy, 
     e.g.: For a DOS-Formatted floppy,
      # mount -t msdos /dev/fd0 /mnt
      # cp /mnt/iir-1.1.tgz /tmp/iir-1.1.tgz
      # umount /mnt
   - Install the package with the command
      # pkg_add iir-1.1.tgz
     This command will install the IIR driver, IIR driver source code, modify 
     system config files appropriately, STORCON.IIRCFG and SRCD utilities. For
     more information on this utilities refer to their man pages.
   - The installed package contains the iir driver for FreeBSD 4.x.
      
     IIR driver can also be linked statically (see below).
      

9. Reboot
   - From now on the driver is loaded automatically as a module at boot time.
   - STORCON is installed and can be used to manage the IIR RAID subsystem by
     invoking the following command:
	# /usr/sbin/storcon
   - Configure SRCD, by invoking the following command:
	# /usr/sbin/srcdconf.sh

    
B. Installing "iir-1.1.tgz" IIR Driver and utilities package on a FreeBSD System
--------------------------------------------------------------------------------

Procedure identical as described above in steps 8. and 9.


C. Link IIR Driver statically
-----------------------------
Use the following steps to compile the IIR drivers from the installed sources.
This procedure can be used for any FreeBSD version.

1. The kernel sources have to be installed
   - This is true if for instance the directory /usr/src/sys/conf exists.
   - If not yet installed:
      Uninstall the IIR Package. For e.g.:
       # pkg_delete iir-1.1
      Load Sysinstall:
       /stand/sysinstall
      Choose menu options "Configure" and "Distributions",
      select checkboxes "iir" and "sys",
      confirm with OK, select installation source (CD-ROM), install
      Leave Sysinstall, install driver package. For e.g.:
       # pkg_add iir-1.1.tgz

2. Modify the Configuration File
   - Package has created the Config.-File /usr/src/sys/i386/conf/IIR_KERNEL,
     Driver is already entered there
     Kernel can be configured here (remove driver etc.)
   - Create System Configuration Files with
      # cd /usr/src/sys/i386/conf
      # config IIR_KERNEL
      (even if IIR_KERNEL is unchanged, always carry out this step)

3. Create Kernel
   - Based on point 2. with
      # cd ../../compile/IIR_KERNEL
      # make depend
      # make
      # make install

4. Reboot
   - The newly compiled IIR driver is now a part of the kernel


D. Troubleshooting
------------------

1. How to configure more than 16 SCSI disks on a system.

	The IIR Host drives are detected as SCSI direct access disk
(Disk Device code: da) by the FreeBSD system. IIR supports a maximum 
of 100 SCSI direct access disks. You can use the "dmesg" command to
check the number of "da" devices detected by the system
	If there are more than 16 "da" devices (corresponding to the
device files /dev/da0 to /dev/da15) then you will need to create
additional device files in the /dev directory to be able to access
those disks.  After the system boots up, do the following
steps:
	a) "dmesg | more "
		Figure out the disk devices which were detected. The
		devices detected should be of the form "da##" where
		# stands for the nth SCSI direct access disk detected.
	b) "cd /dev/ ; sh MAKEDEV da##" (where ## > 15) 	
		The MAKEDEV script will create the device file with
		the appropriate MAJOR device number.
	c) Once you have created the required device nodes, you can 
	   now access those disk drives. Bring up /stand/sysinstall
           application and go to "configure->fdisk". The screen will
           now correctly display all the disks in the system.

--end

