/* sysTffs.c - Motorola MVME177 system-dependent TrueFFS library *//* Copyright 1984-1997 Wind River Systems, Inc. */#include "copyright_wrs.h"/* FAT-FTL Lite Software Development Kit * Copyright (C) M-Systems Ltd. 1995-1996	*//*modification history--------------------01j,31may99,yp  Added comments suggested in SPR #2531901i,21apr98,yp   added tffs to files included from there01h,11mar98,yp   made including tffsConfig.c conditional so man page                 generation does not include it.01g,09mar99,kbw  made man page edits to fix problems found by QE01f,02jan98,yp   doc cleanup 01e,18dec97,hdn  added comment.  cleaned up.01d,05dec97,hdn  added tffsSocket[].  cleaned up.01c,11nov97,hdn  fixed typo.01b,05nov97,hdn  cleaned up.01a,09oct97,and  written by Andray in M-Systems*//*DESCRIPTIONThis library provides board-specific hardware access routines for TrueFFS.  In effect, these routines comprise the socket component driver (or drivers)for your flash device hardware.  At socket registration time, TrueFFS stores pointers to the functions of this socket component driver in an 'FLSocket' structure.  When TrueFFS needs to access the flash device, it uses these functions.  Because this file is, for the most part, a device driver that exports its functionality by registering function pointers with TrueFFS, very few of the functions defined here are externally callable.  For the record, these external functions are flFitInSocketWindow() and flDelayLoop().  You should never have any need to call these functions.  However, one of the most import functions defined in this file is neitherreferenced in an 'FLSocket' structure, nor is it externally callable.  Thisfunction is sysTffsInit().  TrueFFS calls this function at initialization time to register socket component drivers for all the flash devices attached to your target.  It is this call to sysTffs() that results in assigning drive numbers to the flash devices on your target hardware.  Drive numbers are assigned by the order in which the socket component drivers are registered.The first to be registered is drive 0, the second is drive 1, and so on up to 4.  As shipped, TrueFFS supports up to five flash drives.  After registering socket component drivers for a flash device, you may format the flash medium even though there is not yet a block device driverassociated with the flash (see the reference entry for the tffsDevCreate() routine).  To format the flash medium for use with TrueFFS, call tffsDevFormat() or, for some BSPs, sysTffsFormat().  The sysTffsFormat() routine is an optional but BSP-specific externally callable helper function.  Internally, it calls tffsDevFormat() with a pointer to a 'FormatParams' structure initialized to values that leave a space on the flash device for a boot image. This space is outside the region managed by TrueFFS.  This special region is necessary for boot images because the normal translation and wear-leveling services of TrueFFS are incompatible with the needs of the boot program and the boot image it relies upon.  To write a boot image (or any other data) into this area, use tffsBootImagePut().  Finally, this file also contains define statements for symbolic constants that determine which MTDs, translation layer modules, and other utilities are ultimately included in TrueFFS.  These defines are as follows:.IP "INCLUDE_TL_NFTL"To include the NAND-based translation layer module..IP "INCLUDE_TL_FTL"To include the NOR-based translation layer module..IP "INCLUDE_TL_SSFDC"To include the SSFDC-appropriate translation layer module..IP "INCLUDE_MTD_I28F016"For Intel 28f016 flash devices..IP "INCLUDE_MTD_I28F008"For Intel 28f008 flash devices..IP "INCLUDE_MTD_I28F008_BAJA"For Intel 28f008 flash devices on the Heurikon Baja 4700..IP "INCLUDE_MTD_AMD"For AMD, Fujitsu: 29F0{40,80,16} 8-bit flash devices..IP "INCLUDE_MTD_CDSN"For Toshiba, Samsung: NAND CDSN flash devices..IP "INCLUDE_MTD_DOC2"For Toshiba, Samsung: NAND DOC flash devices..IP "INCLUDE_MTD_CFISCS"For CFI/SCS flash devices..IP "INCLUDE_MTD_WAMD"For AMD, Fujitsu 29F0{40,80,16} 16-bit flash devices..IP "INCLUDE_TFFS_BOOT_IMAGE"To include tffsBootImagePut() in TrueFFS for Tornado..LPTo exclude any of the modules mentioned above, edit sysTffs.c and undefineits associated symbolic constant.INCLUDE FILES: flsocket.h, tffsDrv.hSEE ALSO : tffsDrv tffsConfig*/#include "vxWorks.h"#include "config.h"#include "tffs/flsocket.h"#include "tffs/tffsDrv.h"/* defines */#define	INCLUDE_MTD_LV160#undef	INCLUDE_MTD_I28F016		/* Intel: 28f016 */#undef	INCLUDE_MTD_I28F008		/* Intel: 28f008 */#undef	INCLUDE_MTD_AMD			/* AMD, Fujitsu: 29f0{40,80,16} 8bit */#undef	INCLUDE_MTD_CDSN		/* Toshiba, Samsung: NAND, CDSN */#undef	INCLUDE_MTD_DOC2		/* Toshiba, Samsung: NAND, DOC */#undef	INCLUDE_MTD_CFISCS		/* CFI/SCS */#undef	INCLUDE_MTD_WAMD		/* AMD, Fujitsu: 29f0{40,80,16} 16bit */#undef	INCLUDE_TL_NFTL			/* NFTL translation layer */#define	INCLUDE_TL_FTL			/* FTL translation layer */#undef	INCLUDE_TL_SSFDC		/* SSFDC translation layer */#undef 	INCLUDE_TFFS_BOOT_IMAGE	/* include tffsBootImagePut() */#define	FLASH_BASE_ADRS			(0x02000000)#define	FLASH_SIZE		    	(0x00200000)#define FLASH_BOOT_ADRS			(0x02000000)#define	FLASH_BOOT_SIZE		    (0x00000000)/* locals *//* forward declarations */LOCAL void		rfaWriteProtect (void);LOCAL void		rfaWriteEnable (void);LOCAL FLBoolean		rfaCardDetected (FLSocket vol);LOCAL void		rfaVccOn (FLSocket vol);LOCAL void		rfaVccOff (FLSocket vol);#ifdef	SOCKET_12_VOLTSLOCAL FLStatus		rfaVppOn (FLSocket vol);LOCAL void		rfaVppOff (FLSocket vol);#endif	/* SOCKET_12_VOLTS */LOCAL FLBoolean		rfaGetAndClearCardChangeIndicator (FLSocket vol);LOCAL FLBoolean		rfaWriteProtected (FLSocket vol);LOCAL void		rfaSetWindow (FLSocket vol);LOCAL void		rfaSetMappingContext (FLSocket vol, unsigned page);LOCAL FLStatus		rfaSocketInit (FLSocket vol);LOCAL FLStatus		rfaRegister (void);#ifndef DOC/*#include "tffs/tffsConfig.c"*/#include "tffsConfig.c"#endif /* DOC *//********************************************************************************* sysTffsInit - board-level initialization for TrueFFS** This routine calls the socket registration routines for the socket component* drivers that will be used with this BSP. The order of registration determines* the logical drive number given to the drive associated with the socket.** RETURNS: N/A*/LOCAL void sysTffsInit (void)    {        rfaRegister ();    rfaRegister ();    }/********************************************************************************* rfaRegister - registration routine for the RFA on MVME177** This routine populates the 'vol' structure for a logical drive with the* socket component driver routines for the RFA on the MVME177 board. All* socket routines are referanced through the 'vol' structure and never * from here directly** RETURNS: flOK, or flTooManyComponents if there're too many drives*/LOCAL FLStatus rfaRegister (void)    {    FLSocket vol = flSocketOf (noOfDrives);    if (noOfDrives >= DRIVES)        return (flTooManyComponents);    tffsSocket[noOfDrives] = "RFA";        vol.serialNo = noOfDrives;    if  (noOfDrives == 0)    	vol.window.baseAddress = FLASH_BASE_ADRS >> 12;    else if(noOfDrives == 1)		vol.window.baseAddress = FLASH_BOOT_ADRS >> 12;	noOfDrives++;    /* fill in function pointers */    vol.cardDetected      = rfaCardDetected;    vol.VccOn             = rfaVccOn;    vol.VccOff            = rfaVccOff;#ifdef SOCKET_12_VOLTS    vol.VppOn             = rfaVppOn;    vol.VppOff            = rfaVppOff;#endif    vol.initSocket        = rfaSocketInit;    vol.setWindow         = rfaSetWindow;    vol.setMappingContext = rfaSetMappingContext;    vol.getAndClearCardChangeIndicator =                          rfaGetAndClearCardChangeIndicator;    vol.writeProtected    = rfaWriteProtected;    return (flOK);    }/********************************************************************************* rfaCardDetected - detect if a card is present (inserted)** This routine detects if a card is present (inserted).** RETURNS: TRUE, or FALSE if the card is not present.*/LOCAL FLBoolean rfaCardDetected    (    FLSocket vol    )    {    return (TRUE);    }/********************************************************************************* rfaVccOn - turn on Vcc (3.3/5 Volts)** This routine turns on Vcc (3.3/5 Volts).  Vcc must be known to be good* on exit.** RETURNS: N/A*/LOCAL void rfaVccOn     (    FLSocket vol    )    {    rfaWriteEnable ();    }/********************************************************************************* rfaVccOff - turn off Vcc (3.3/5 Volts)** This routine turns off Vcc (3.3/5 Volts). ** RETURNS: N/A*/LOCAL void rfaVccOff     (    FLSocket vol    )    {    rfaWriteProtect ();    }#ifdef SOCKET_12_VOLTS/********************************************************************************* rfaVppOn - turns on Vpp (12 Volts)** This routine turns on Vpp (12 Volts). Vpp must be known to be good on exit.*