hkbaja47-sysTffs.c
上传用户:luoyougen
上传日期:2008-05-12
资源大小:23136k
文件大小:15k
源码类别:

VxWorks

开发平台:

C/C++

  1. /* sysTffs.c - Heurikon Baja4700 system-dependent TrueFFS library */
  2. /* Copyright 1984-1997 Wind River Systems, Inc. */
  3. #include "copyright_wrs.h"
  4. /* FAT-FTL Lite Software Development Kit
  5.  * Copyright (C) M-Systems Ltd. 1995-1997 */
  6. /*
  7. modification history
  8. --------------------
  9. 01f,31may99,yp   Added comments suggested in SPR #25319
  10. 01e,21apr98,yp   added tffs to files included from there
  11. 01d,11mar98,yp   made including tffsConfig.c conditional so man page
  12.                  generation does not include it.
  13. 01c,09mar98,kbw  made edits to the man pages to fix problems found by QE
  14. 01b,04mar98,kbw  made edits to the man pages
  15. 01a,23dec97,hdn  written.
  16. */
  17. /*
  18. DESCRIPTION
  19. This library provides board-specific hardware access routines for TrueFFS.  
  20. In effect, these routines comprise the socket component driver (or drivers)
  21. for your flash device hardware.  At socket registration time, TrueFFS stores 
  22. pointers to the functions of this socket component driver in an 'FLSocket' 
  23. structure.  When TrueFFS needs to access the flash device, it uses these 
  24. functions.  
  25. Because this file is, for the most part, a device driver that exports its 
  26. functionality by registering function pointers with TrueFFS, very few of the 
  27. functions defined here are externally callable.  For the record, these 
  28. external functions are flFitInSocketWindow() and flDelayLoop().  You should 
  29. never have any need to call these functions.  
  30. However, one of the most import functions defined in this file is neither
  31. referenced in an 'FLSocket' structure, nor is it externally callable.  This
  32. function is sysTffsInit().  TrueFFS calls this function at initialization 
  33. time to register socket component drivers for all the flash devices attached 
  34. to your target.  It is this call to sysTffs() that results in assigning 
  35. drive numbers to the flash devices on your target hardware.  Drive numbers 
  36. are assigned by the order in which the socket component drivers are registered.
  37. The first to be registered is drive 0, the second is drive 1, and so on up to 
  38. 4.  As shipped, TrueFFS supports up to five flash drives.  
  39. After registering socket component drivers for a flash device, you may 
  40. format the flash medium even though there is not yet a block device driver
  41. associated with the flash (see the reference entry for the tffsDevCreate() 
  42. routine).  To format the flash medium for use with TrueFFS, 
  43. call tffsDevFormat() or, for some BSPs, sysTffsFormat().  
  44. The sysTffsFormat() routine is an optional but BSP-specific externally 
  45. callable helper function.  Internally, it calls tffsDevFormat() with a 
  46. pointer to a 'FormatParams' structure initialized to values that leave a 
  47. space on the flash device for a boot image. This space is outside the 
  48. region managed by TrueFFS.  This special region is necessary for boot 
  49. images because the normal translation and wear-leveling services of TrueFFS 
  50. are incompatible with the needs of the boot program and the boot image it 
  51. relies upon.  To write a boot image (or any other data) into this area, 
  52. use tffsBootImagePut().  
  53. Finally, this file also contains define statements for symbolic constants 
  54. that determine which MTDs, translation layer modules, and other utilities 
  55. are ultimately included in TrueFFS.  These defines are as follows:
  56. .IP "INCLUDE_TL_NFTL"
  57. To include the NAND-based translation layer module.
  58. .IP "INCLUDE_TL_FTL"
  59. To include the NOR-based translation layer module.
  60. .IP "INCLUDE_TL_SSFDC"
  61. To include the SSFDC-appropriate translation layer module.
  62. .IP "INCLUDE_MTD_I28F016"
  63. For Intel 28f016 flash devices.
  64. .IP "INCLUDE_MTD_I28F008"
  65. For Intel 28f008 flash devices.
  66. .IP "INCLUDE_MTD_I28F008_BAJA"
  67. For Intel 28f008 flash devices on the Heurikon Baja 4700.
  68. .IP "INCLUDE_MTD_AMD"
  69. For AMD, Fujitsu: 29F0{40,80,16} 8-bit flash devices.
  70. .IP "INCLUDE_MTD_CDSN"
  71. For Toshiba, Samsung: NAND CDSN flash devices.
  72. .IP "INCLUDE_MTD_DOC2"
  73. For Toshiba, Samsung: NAND DOC flash devices.
  74. .IP "INCLUDE_MTD_CFISCS"
  75. For CFI/SCS flash devices.
  76. .IP "INCLUDE_MTD_WAMD"
  77. For AMD, Fujitsu 29F0{40,80,16} 16-bit flash devices.
  78. .IP "INCLUDE_TFFS_BOOT_IMAGE"
  79. To include tffsBootImagePut() in TrueFFS for Tornado.
  80. .LP
  81. To exclude any of the modules mentioned above, edit sysTffs.c and undefine
  82. its associated symbolic constant.
  83. INCLUDE FILES: flsocket.h, tffsDrv.h
  84. */
  85. #include "vxWorks.h"
  86. #include "config.h"
  87. #include "tffs/flsocket.h"
  88. #include "tffs/tffsDrv.h"
  89. /* defines */
  90. #undef INCLUDE_MTD_I28F016 /* Intel: 28f016 */
  91. #undef INCLUDE_MTD_I28F008 /* Intel: 28f008 */
  92. #define INCLUDE_MTD_I28F008_BAJA /* Intel: 28f008 for Baja4700 */
  93. #undef INCLUDE_MTD_AMD /* AMD, Fujitsu: 29f0{40,80,16} 8bit */
  94. #undef INCLUDE_MTD_CDSN /* Toshiba, Samsung: NAND, CDSN */
  95. #undef INCLUDE_MTD_DOC2 /* Toshiba, Samsung: NAND, DOC */
  96. #undef INCLUDE_MTD_CFISCS /* CFI/SCS */
  97. #undef INCLUDE_MTD_WAMD /* AMD, Fujitsu: 29f0{40,80,16} 16bit */
  98. #undef INCLUDE_TL_NFTL /* NFTL translation layer */
  99. #define INCLUDE_TL_FTL /* FTL translation layer */
  100. #undef INCLUDE_TL_SSFDC /* SSFDC translation layer */
  101. #define INCLUDE_TFFS_BOOT_IMAGE /* include tffsBootImagePut() */
  102. #define FLASH_BASE_ADRS 0x1d400000 /* Flash ROM 1 */
  103. #if FALSE
  104. #define FLASH_BASE_ADRS 0x1d800000 /* Flash ROM 2 */
  105. #define FLASH_BASE_ADRS 0x1dc00000 /* Flash ROM 3 */
  106. #endif /* FALSE */
  107. #define FLASH_SIZE 0x100000
  108. #define SETUP_WRITE 0x40
  109. /* externs */
  110. extern void sysWbFlush ();
  111. /* locals */
  112. /* forward declarations */
  113. LOCAL FLBoolean rfaCardDetected (FLSocket vol);
  114. LOCAL void rfaVccOn (FLSocket vol);
  115. LOCAL void rfaVccOff (FLSocket vol);
  116. #ifdef SOCKET_12_VOLTS
  117. LOCAL FLStatus rfaVppOn (FLSocket vol);
  118. LOCAL void rfaVppOff (FLSocket vol);
  119. #endif /* SOCKET_12_VOLTS */
  120. LOCAL FLBoolean rfaGetAndClearCardChangeIndicator (FLSocket vol);
  121. LOCAL FLBoolean rfaWriteProtected (FLSocket vol);
  122. LOCAL void rfaSetWindow (FLSocket vol);
  123. LOCAL void rfaSetMappingContext (FLSocket vol, unsigned page);
  124. LOCAL FLStatus rfaSocketInit (FLSocket vol);
  125. LOCAL FLStatus rfaRegister (void);
  126. #ifndef DOC
  127. #include "tffs/tffsConfig.c"
  128. #endif /* DOC */
  129. /*******************************************************************************
  130. *
  131. * sysTffsInit - initialize TFFS flash socket interface routine.
  132. *
  133. * This is the TFFS flash socket interface initialization routine.
  134. *
  135. * RETURNS: N/A
  136. */
  137. LOCAL void sysTffsInit (void)
  138.     {
  139.     rfaRegister ();
  140.     }
  141. /*******************************************************************************
  142. *
  143. * rfaRegister - install routines for the RFA
  144. *
  145. * This routine installs necessary functions for the RFA.
  146. *
  147. * RETURNS: flOK, or flTooManyComponents if there're too many drives
  148. */
  149. LOCAL FLStatus rfaRegister (void)
  150.     {
  151.     FLSocket vol = flSocketOf (noOfDrives);
  152.     if (noOfDrives >= DRIVES)
  153.         return (flTooManyComponents);
  154.     tffsSocket[noOfDrives] = "RFA";
  155.     noOfDrives++;
  156.     vol.serialNo = 0;
  157.     vol.window.baseAddress = FLASH_BASE_ADRS >> 12;
  158.     /* fill in function pointers */
  159.     vol.cardDetected      = rfaCardDetected;
  160.     vol.VccOn             = rfaVccOn;
  161.     vol.VccOff            = rfaVccOff;
  162. #ifdef SOCKET_12_VOLTS
  163.     vol.VppOn             = rfaVppOn;
  164.     vol.VppOff            = rfaVppOff;
  165. #endif
  166.     vol.initSocket        = rfaSocketInit;
  167.     vol.setWindow         = rfaSetWindow;
  168.     vol.setMappingContext = rfaSetMappingContext;
  169.     vol.getAndClearCardChangeIndicator =
  170.                           rfaGetAndClearCardChangeIndicator;
  171.     vol.writeProtected    = rfaWriteProtected;
  172.     return (flOK);
  173.     }
  174. /*******************************************************************************
  175. *
  176. * rfaCardDetected - detect if a card is present (inserted)
  177. *
  178. * This routine detects if a card is present (inserted).
  179. *
  180. * RETURNS: TRUE, or FALSE if the card is not present.
  181. */
  182. LOCAL FLBoolean rfaCardDetected
  183.     (
  184.     FLSocket vol
  185.     )
  186.     {
  187.     return (TRUE);
  188.     }
  189. /*******************************************************************************
  190. *
  191. * rfaVccOn - turn on Vcc (3.3/5 Volts)
  192. *
  193. * This routine turns on Vcc (3.3/5 Volts).  Vcc must be known to be good
  194. * on exit.
  195. *
  196. * RETURNS: N/A
  197. */
  198. LOCAL void rfaVccOn 
  199.     (
  200.     FLSocket vol
  201.     )
  202.     {
  203.     }
  204. /*******************************************************************************
  205. *
  206. * rfaVccOff - turn off Vcc (3.3/5 Volts)
  207. *
  208. * This routine turns off Vcc (3.3/5 Volts). 
  209. *
  210. * RETURNS: N/A
  211. */
  212. LOCAL void rfaVccOff 
  213.     (
  214.     FLSocket vol
  215.     )
  216.     {
  217.     }
  218. #ifdef SOCKET_12_VOLTS
  219. /*******************************************************************************
  220. *
  221. * rfaVppOn - turns on Vpp (12 Volts)
  222. *
  223. * This routine turns on Vpp (12 Volts). Vpp must be known to be good on exit.
  224. *
  225. * RETURNS: flOK always
  226. */
  227. LOCAL FLStatus rfaVppOn
  228.     (
  229.     FLSocket vol /* pointer identifying drive */
  230.     )
  231.     {
  232.     return (flOK);
  233.     }
  234. /*******************************************************************************
  235. *
  236. * rfaVppOff - turns off Vpp (12 Volts)
  237. *
  238. * This routine turns off Vpp (12 Volts).
  239. *
  240. * RETURNS: N/A
  241. */
  242. LOCAL void rfaVppOff 
  243.     (
  244.     FLSocket vol /* pointer identifying drive */
  245.     ) 
  246.     {
  247.     }
  248. #endif /* SOCKET_12_VOLTS */
  249. /*******************************************************************************
  250. *
  251. * rfaSocketInit - perform all necessary initializations of the socket
  252. *
  253. * This routine performs all necessary initializations of the socket.
  254. *
  255. * RETURNS: flOK always
  256. */
  257. LOCAL FLStatus rfaSocketInit
  258.     (
  259.     FLSocket vol /* pointer identifying drive */
  260.     ) 
  261.     {
  262.     vol.cardChanged = FALSE;
  263.     /* enable memory window and map it at address 0 */
  264.     rfaSetWindow (&vol);
  265.     return (flOK);
  266.     }
  267. /*******************************************************************************
  268. *
  269. * rfaSetWindow - set current window attributes, Base address, size, etc
  270. *
  271. * This routine sets current window hardware attributes: Base address, size,
  272. * speed and bus width.  The requested settings are given in the 'vol.window' 
  273. * structure.  If it is not possible to set the window size requested in
  274. * 'vol.window.size', the window size should be set to a larger value, 
  275. * if possible. In any case, 'vol.window.size' should contain the 
  276. * actual window size (in 4 KB units) on exit.
  277. *
  278. * RETURNS: N/A
  279. */
  280. LOCAL void rfaSetWindow
  281.     (
  282.     FLSocket vol /* pointer identifying drive */
  283.     ) 
  284.     {
  285.     /* Physical base as a 4K page */
  286.     vol.window.baseAddress = FLASH_BASE_ADRS >> 12;
  287.     flSetWindowSize (&vol, FLASH_SIZE >> 12);
  288.     }
  289. /*******************************************************************************
  290. *
  291. * rfaSetMappingContext - sets the window mapping register to a card address
  292. *
  293. * This routine sets the window mapping register to a card address.
  294. * The window should be set to the value of 'vol.window.currentPage',
  295. * which is the card address divided by 4 KB. An address over 128MB,
  296. * (page over 32K) specifies an attribute-space address. On entry to this 
  297. * routine vol.window.currentPage is the page already mapped into the window.
  298. * (In otherwords the page that was mapped by the last call to this routine.)
  299. *
  300. * The page to map is guaranteed to be on a full window-size boundary.
  301. *
  302. * RETURNS: N/A
  303. */
  304. LOCAL void rfaSetMappingContext 
  305.     (
  306.     FLSocket vol, /* pointer identifying drive */
  307.     unsigned page /* page to be mapped */
  308.     )
  309.     {
  310.     }
  311. /*******************************************************************************
  312. *
  313. * rfaGetAndClearCardChangeIndicator - return the hardware card-change indicator
  314. *
  315. * This routine returns the hardware card-change indicator and clears it if set.
  316. *
  317. * RETURNS: FALSE, or TRUE if the card has been changed
  318. */
  319. LOCAL FLBoolean rfaGetAndClearCardChangeIndicator
  320.     (
  321.     FLSocket vol /* pointer identifying drive */
  322.     ) 
  323.     {
  324.     return (FALSE);
  325.     }
  326. /*******************************************************************************
  327. *
  328. * rfaWriteProtected - return the write-protect state of the media
  329. *
  330. * This routine returns the write-protect state of the media
  331. *
  332. * RETURNS: FALSE, or TRUE if the card is write-protected
  333. */
  334. LOCAL FLBoolean rfaWriteProtected 
  335.     (
  336.     FLSocket vol /* pointer identifying drive */
  337.     ) 
  338.     {
  339.     return (FALSE);
  340.     }
  341. /*******************************************************************************
  342. *
  343. * flFitInSocketWindow - check whether the flash array fits in the socket window
  344. f
  345. * This routine checks whether the flash array fits in the socket window.
  346. *
  347. * RETURNS: A chip size guaranteed to fit in the socket window.
  348. */
  349. long int flFitInSocketWindow
  350.     (
  351.     long int chipSize, /* size of single physical chip in bytes */
  352.     int      interleaving, /* flash chip interleaving (1,2,4 etc) */
  353.     long int windowSize /* socket window size in bytes */
  354.     )
  355.     {
  356.     return (chipSize);
  357.     }
  358. #if FALSE
  359. /*******************************************************************************
  360. *
  361. * sysTffsCpy - copy memory from one location to another
  362. *
  363. * This routine copies <size> characters from the object pointed
  364. * to by <source> into the object pointed to by <destination>. If copying
  365. * takes place between objects that overlap, the behavior is undefined.
  366. *
  367. * INCLUDE FILES: string.h
  368. *
  369. * RETURNS: A pointer to <destination>.
  370. *
  371. * NOMANUAL
  372. */
  373. void * sysTffsCpy
  374.     (
  375.     void *       destination,   /* destination of copy */
  376.     const void * source,        /* source of copy */
  377.     size_t       size           /* size of memory to copy */
  378.     )
  379.     {
  380.     bcopy ((char *) source, (char *) destination, (size_t) size);
  381.     return (destination);
  382.     }
  383. /*******************************************************************************
  384. *
  385. * sysTffsSet - set a block of memory
  386. *
  387. * This routine stores <c> converted to an `unsigned char' in each of the
  388. * elements of the array of `unsigned char' beginning at <m>, with size <size>.
  389. *
  390. * INCLUDE FILES: string.h
  391. *
  392. * RETURNS: A pointer to <m>.
  393. *
  394. * NOMANUAL
  395. */
  396. void * sysTffsSet
  397.     (
  398.     void * m,                   /* block of memory */
  399.     int    c,                   /* character to store */
  400.     size_t size                 /* size of memory */
  401.     )
  402.     {
  403.     bfill ((char *) m, (int) size, c);
  404.     return (m);
  405.     }
  406. #endif /* FALSE */
  407. /*******************************************************************************
  408. *
  409. * flDelayLoop - consume the specified time
  410. *
  411. * This routine consumes the specified time.
  412. *
  413. * RETURNS: N/A
  414. */
  415. void flDelayLoop 
  416.     (
  417.     int cycles /* loop count to be consumed */
  418.     )
  419.     {
  420.     }
  421. /*******************************************************************************
  422. *
  423. * sysTffsByteWrite - write byte to the flash memory
  424. *
  425. * This routine write byte to the flash memory
  426. *
  427. * RETURNS: N/A
  428. *
  429. * NOMANUAL
  430. */
  431. void sysTffsByteWrite 
  432.     (
  433.     char *pAddr, /* address */
  434.     char value /* value */
  435.     )
  436.     {
  437.     volatile char * pAligned = (volatile char *)((int)pAddr & ~3);
  438.     unsigned long offset = ((int)pAddr & 3);
  439.     /* setup pig control register for byte offset */
  440.     *PIG_CONTROL = (*PIG_CONTROL & ~0x700) | (offset << 8);
  441.     /* do the write */
  442.     *pAligned = SETUP_WRITE;
  443.     *pAligned = value;
  444. #if (CPU == R4000)
  445.     sysWbFlush();
  446. #endif /* (CPU == R4000) */
  447.     }