
#pragma	ident	"@(#)README	1.8	97/09/02 SMI"

/*
 * Copyright (c) 1997 by Sun Microsystems, Inc.
 */


DRIVER NAME:

	isp - sample SCSI Host Bus Adapter driver for Solaris 2.6

ARCHITECTURES:

	SPARC and x86

DESCRIPTION OF DRIVER:

	This driver presents an example of how to write a SCSI
	Host Bus Adapter (HBA) driver for Solaris 2.6.

	The driver is written to control the QLogics Intelligent
	SCSI Peripheral (ISP) 1000 or 1020 chips.  At the time
	of writing, the SBUS ISP card uses the ISP 1000, and
	the PCI ISP card uses the ISP 1020.
	

SOURCE FILES:

	isp.c:			primary source file for the isp driver

	ispvar.h:		isp softstate structure and definitions

	ispcmd.h:		isp per-packet private data

	ispreg.h:		isp register definitions and structures

	ispmail.h:		isp mailbox definitions and structures

	isp.conf:		driver.conf(4) file for isp driver

	Makefile:		Makefile for isp driver (defaults to 1020)

	Makefile.1000:		Makefile for isp 1000 driver

	Makefile.1020:		Makefile for isp 1020 driver

	README:			this file

	Install_1000.sh:	driver installation script (1000 version)

	Install_1020.sh:	driver installation script (1020 version)

	Remove.sh:		driver removal script


CAVEATS AND CONSTRAINTS

	The 1000 version of the driver requires version 1.16 of
	the ISP firmware, or better.  Firmware versions earlier
	than 1.16 contain known bugs that preclude operation
	with this driver.
	The 1000 version has been successfully tested on SPARC SBUS systems.
	The 1020 version will not operate on SPARC PCI systems but
	has been successfully tested on x86 systems.


COMPILING AND LOADING:

	To compile the driver, use the Makefile provided in
	the directory src/driver_dev/isp.  The build automatically
	creates either a 'sparc' or an 'i386' directory, depending
	upon the machine type, and places the resulting binary
	in the appropriate directory.  The default Makefile
	builds the driver for the 1020 version of isp.

	To build the driver for the 1000 version of the isp,
	either copy Makefile.1000 on top of Makefile, or
	run make like this:

		% make -f Makefile.1000


	To install 1000 version of the driver, run as root:

		# sh Install_1000.sh
		# reboot


	To install 1020 version of the driver, run as root:

		# sh Install_1020.sh
		# reboot


	To remove driver from the system, run as root:

		# sh Remove.sh
		# reboot

REFERENCES:

	SunOS 5.6 Writing Device Drivers
	ISP1000 Intelligent SCSI Processor Technical Manual
	ISP1020 Intelligent SCSI Processor Technical Manual

	The ISP technical manuals may be obtained from:

		QLogic Corporation
		3545 Harbor Blvd.
		P.O. Box 5001
		Costa Mesa, CA  92628-5001
		Tel: 1-800-ON CHIP-1
		Fax: 1-714-668-5008
