Installation Notes for the CCII END FC Driver
---------------------------------------------


Version      : 1.1
Release date : 2002-10-09


1. 	FDDI Shim Modules
   	-----------------
   	In some instances, the CCII FC adapter will be used to replace the CCII FDDI
   	adapter in existing systems. Load the shim module to restore the difference.
   	See the "User Manual for the CCII Systems PMC Fibre Channel END Driver" for 
   	more details. 


2. 	To Build Driver into Kernel
   	---------------------------
		See vxWorks documentation to build driver into kernel.
    Please use the ccfcEndxxx.a lib file for this.

  	where xxx=X86    for X86      HCC
          xxx=179    for SVME179  HCC
          xxx=Mv5100 for MVME5100 HCC

		2.1.	Copy ccfcEndxxx.a and ccFddiShim.o to your BSP library directory (see note 1.)
          (/tornado/target/config/xxx/lib).

   	2.2.	Edit the Makefile in the BSP directory (/tornado/target/config/xxx).
	
					Find the line
					MACH_EXTRA	=

					and replace with
					MACH_EXTRA	=	./lib/ccFcEndxxx.a /lib/ccFddiShim.o (see note 1.)
		
   	2.3.	Add the following code fragment to config.h 
        	(before "#define DEFAULT_BOOT_LINE"):
		
     			/*Added by CCII for FC driver*/
	 				#define INCLUDE_CCFC_END     /* CCII FC END DRIVER */ 


	 				/* CCII Modification */
	 				#ifdef INCLUDE_CCFC_END
	 				#ifndef INCLUDE_PCI
	 				#define INCLUDE_PCI
	 				#endif

	 				#ifdef INCLUDE_BSD
	 				#undef INCLUDE_BSD
	 				#endif

	 				#ifndef INCLUDE_END
	 				#define INCLUDE_END
  				#endif
	 				#endif   

	 				/*End  CCII Modification */

		2.4.	In config.h, change the DEFAULT_BOOT_LINE to use the ccfc driver.

    2.5.	Add the following to configNet.h

					(Before the start of the endDevTbl[] declaration.)

					IMPORT END_OBJ * ccfcLoad (char *initString); 

					(Add the following segment to the endDevTbl[] , before the default last entry.)

					#ifdef INCLUDE_CCFC_END (see note 2.)
					{ 0, ccfcLoad, "", NULL, NULL, FALSE}, /*To include unit 0*/
					{ 1, ccfcLoad, "", NULL, NULL, FALSE}, /*To include unit 1*/
					#endif /* INCLUDE_CCFC_END */ 

		
		2.6. 	Rebuild all vxWorks images.


		Note 1: Only include "ccFddiShim.o if the shim is needed.
		Note 2: Refer to section 5 below for initialisation parameters.
		
3.	To load separately
		------------------

		From the vxWorks shell type: 'ld < ccFcEndxxx.a'
       
		If FDDI shim is needed:   	 'ld < ccFddiShim.o'


4.	Starting the driver manually
		----------------------------

		The driver is started with the muxDevLoad and muxDevStart commands. 
		The syntax is as follows:
   
   	muxDevStart ( muxDevLoad ( unit, ccfcLoad, "", 0, 0 )) (see note 1.)
 
		This is only necessary if the driver was not include in the configNet.h file.
		Type 'muxShow' to see if the driver was installed.

		To attach the driver to the TCP/IP protocol:
	  ipAttach ( unit, "ccfc" )

		To set the IP address use ifAddrSet eg
    ifAddrSet "ccfc0" , "10.0.0.1" for unit 0.
    ifAddrSet "ccfc1" , "10.0.1.1" for unit 1.
   
		Note 1: Refer to section 5 below for initialisation parameters.
		
5.	User Defined Parameters
		-----------------------
		When calling the MUX interface routine 'muxDevLoad()', a target specific initialisation
		string can be entered. This string will contain the total number of RX and TX clusters allocated
		by the driver and the MTU size of the RX clusters. The driver will parse the string for the 
		initialisation parameters. The format of the string will be: 
		
		"Clusters:MTU"
		
		where maximum number of clusters will be limited to 254 clusters and the MTU size be 
		limited to 64K.
		
		If the string = NULL, default parameters will be used.
		
		Example: muxDevLoad(unit,ccfcLoad,"100:4096",0,0))
		
		where Number of Clusters = 100
					MTU size = 4K
		
		
6.	Example Script
		--------------

		ld < ccfcEnd179.a
		muxDevStart(muxDevLoad(0,ccfcLoad,"40:4096",0,0))
		ipAttach(0, "ccfc")
		ifMaskSet("ccfc0","0xffffff00")
		ifAddrSet("ccfc0","192.168.0.1")
		muxDevStart(muxDevLoad(1,ccfcLoad,"40:4096",0,0))
		ipAttach(1, "ccfc")
		ifMaskSet("ccfc1","0xffffff00")
		ifAddrSet("ccfc1","192.168.1.1")