1. freebsd.zip Driver
2. README.TXT File Contents

README.TXT Driver File Contents (freebsd.zip)

Installation Notes for FreeBSD with ICP Disk Array Controllers
==============================================================

Files
-----
readme.txt	this file
icp.ko		ICP driver module for installation of FreeBSD 4.4/4.5-RELEASE
icp2.ko		ICP driver module for installation of FreeBSD 5.0-CURRENT
icp-1.1.tgz	Driver and utilities package
  copies:	icp.c, icp.h, icp_ctrl.c, icp_pci.c to /usr/src/sys/dev/icp
  copies:	icp.ko to /
  copies:	icpcon, icpd to /usr/sbin
  copies:	icpd.sh to /usr/local/etc
  copies:	99icpd.sh to /usr/local/etc/rc.d
  copies:	icpd.conf, icptrap.mib to /etc
  modifies:	/boot/loader.rc (adds icp.ko)
  modifies:	/usr/src/sys/conf/files (adds source files)
  generates:	/dev/icp (special device file for tools, e.g.: icpcon)
  generates:	/usr/src/sys/i386/conf/ICP_KERNEL from GENERIC (with ICP entry)


The ICP Controller is the Boot Controller
-----------------------------------------
1. Configure Host Drive
   - Driver supports currently Host Drives 0 to 99
   - There is a virtual channel for the Host Drives
     (behind the physical channels of the ICP Controller)

2. Boot from the Installation CD
   - Enable CD-ROM Boot within ICPCON (if the CDROM drive is connected with the ICP Controller)
   - We have tested: FreeBSD 4.4/4.5-RELEASE and FreeBSD 5.0-CURRENT
   - 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 and
     'load disk1:icp' (5.0-CURRENT: 'load disk1:icp2')
     to load the ICP 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 (only if a certain driver causes problems
     deactivate it in "Start kernel configuration in full-screen visual mode")
   - Kernel boots and ICP driver recognizes the ICP 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 (English, German, ..)
   - Select Timezone

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

7. Boot from the Host Drive
   - Interrupt the boot process and load the ICP driver (see above 2.)
     Command is this time 'load disk0:icp' (5.0-CURRENT: 'load disk0:icp2')
     since there is no CD in the drive and thus disk0 becomes the floppy
   - Kernel boots, ICP driver detects Host Drives

8. Install driver package
   - Copy file icp-11.tgz from the floppy, e.g.: (DOS-Format):
      'mount -t msdos /dev/fd0 /mnt'
      cp /mnt/icp-11.tgz /tmp/icp-1.1.tgz
      'umount /mnt'
   - Install package with
      'pkg_add icp-1.1.tgz'
   - Package is for FreeBSD 4.4/4.5-RELEASE, with 5.0-CURRENT the driver is either
     linked statically (see below) or the suitable module (icp2.ko) has to be copied
     manually with
      'mount -t msdos /dev/fd0 /mnt'
      'cp /mnt/icp2.ko /icp.ko'
      'umount /mnt'

9. Reboot
   - From now on the driver is loaded automatically as a module
   - ICPCON is installed

    
The ICP Controller is the Secondary Controller
----------------------------------------------
Procedure identical as described above in points 8. and 9.


Link Driver statically
----------------------
The driver is completely new compiled from the sources and therefore
adjustable to any FreeBSD-Version.
Procedure:

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 ICP Package:
       'pkg_delete icp-1.1'
      Load Sysinstall:
       '/stand/sysinstall'
      Choose menu options "Configure" and "Distributions",
      select checkboxes "src" and "sys",
      confirm with OK, select installation source (CD-ROM), install
      Leave Sysinstall, install ICP Package:
       'pkg_add icp-1.1.tgz'

2. Modify the Configuration File
   - Package has created the Config.-File /usr/src/sys/i386/conf/ICP_KERNEL ,
     ICP 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 ICP_KERNEL'
      (even if ICP_KERNEL is unchanged, always carry out this step) 

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

4. Reboot
   - Driver is from now on part of the kernel


ICP Utilities
-------------
1. ICPCON - ICP RAID Console
   ICPCON is a configuration and maintenance tool for ICP controllers. It is copied
   automatically to /usr/sbin during ICP package installation. To start it simply enter
   'icpcon' on the command prompt.

2. ICPD - remote management and notification service
   The remote management and notification service ICPD is automatically installed
   during ICP package installation. ICPD manages remote access, sends SNMP traps
   and allows to start externel programs (e.g. for mail notification). To configure
   this service /etc/icpd.conf needs to be edited:
	e.g.: 'vi /etc/icpd.conf'
   To start, stop or restart ICPD use the following script:
	'sh /usr/local/etc/icpd.sh start' (stop, restart)

Troubleshooting
---------------
1. How to configure more than 16 SCSI disks on a system.
   The ICP Host Drives are detected as SCSI direct access disks (Disk Device code: da)
   by the FreeBSD system. ICP 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.



February 18th, 2002
ICP vortex Computersysteme GmbH