开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 嵌入式/单片机编程 > VxWorks > 查看源码
cacheLib.h
资源名称：ixp425BSP.rar　[点击查看]
上传用户：luoyougen
上传日期：2008-05-12
资源大小：23136k
文件大小：10k
源码类别：

VxWorks

开发平台：

C/C++

cacheLib.h：源码内容
  1. /* cacheLib.h - cache library header file */
  3. /* Copyright 1984-1998 Wind River Systems, Inc. */
  5. /*
  6. modification history
  7. --------------------
  8. 03e,22oct01,dee  merge from T2.1.0 coldfire release
  9. 03d,10sep00,hk   extended CACHE_TYPE for SH7729.
  10. 03c,01mar00,frf  Add SH4 support for T2
  11. 03b,23apr97,hk   added SH support.
  12. 03c,05nov98.jpd  removed cacheArchLibInit definition for ARM.
  13. 03b,28nov96,cdp  added ARM support.
  14. 03a,26may94,yao  added PPC support.
  15. 02p,19mar95,dvs  removed #ifdef TRON - tron no longer supported.
  16. 02o,08jun94,tpr  added branch cache used by MC68060 cpu.
  17. 02n,02dec93,pme  Added Am29K family support.
  18. 02m,09jun93,hdn  added support for I80X86
  19. 02l,19oct92,jcf  reordered xxLibInit params.  made CACHE_TYPE v5.0 compatible.
  20. 02k,29sep92,jwt  merged cacheLibInit(), cacheReset(), and cacheModeSet().
  21. 02j,22sep92,rrr  added support for c++
  22. 02i,20aug92,wmd  added #include for i960.
  23. 02h,13aug92,rdc  removed instances of cacheLib functions and CACHE_FUNCS
  24.    structures and conditional compilation of corresponding
  25.  IMPORTS.
  26. 02g,30jul92,dnw  added cacheLib functions and CACHE_FUNCS structures.
  27. 02f,15jul92,jwt  added more CACHE_MODEs.
  28. 02e,09jul92,jwt  added virtual-to-physical and physical-to-virtual stuff.
  29. 02d,07jul92,ajm  added support for mips
  30. 02c,06jul92,jwt  cleaned up cacheDrvXxx() macros by stressing pointers.
  31. 02b,04jul92,jcf  cleaned up.
  32. 02a,03jul92,jwt  cache library header for 5.1; moved '040 stuff to arch/mc68k.
  33. 01k,16jun92,jwt  made safe for assembly language files.
  34. 01j,26may92,rrr  the tree shuffle
  35.                   -changed includes to have absolute path from h/
  36. 01i,20jan92,shl  added cache68kLib.h.
  37. 01h,09jan92,jwt  created cacheSPARCLib.h;
  38.                  cleaned up ANSI compiler warning messages.
  39. 01g,04oct91,rrr  passed through the ansification filter
  40.                   -fixed #else and #endif
  41.                   -changed copyright notice
  42. 01f,27aug91,shl  added scope type for MC68040 caches.
  43. 01e,19jul91,gae  renamed architecture specific include file to be xx<arch>.h.
  44. 01d,23jan91,jwt  added SPARC cache commands.
  45. 01c,01mar91,hdn  added TRON related stuff.
  46. 01b,05oct90,shl  added copyright notice; made #endif ANSI style.
  47. 01a,15jul90,jcf  written.
  48. */
  50. #ifndef __INCcacheLibh
  51. #define __INCcacheLibh
  53. #ifdef __cplusplus
  54. extern "C" {
  55. #endif
  57. #include "vxWorks.h"
  58. #include "vwModNum.h"
  59. #include "limits.h"
  61. /* Cache types */
  63. #define _INSTRUCTION_CACHE  0 /* Instruction Cache(s) */
  64. #define _DATA_CACHE 1 /* Data Cache(s) */
  65. #define _BRANCH_CACHE 2 /* Branch Cache(s) */
  66. #if (CPU==SH7700)
  67. #define _WAY2_CACHE 3 /* SH7729 only */
  68. #define _WAY3_CACHE 4 /* SH7729 only */
  69. #endif
  71. /* Cache mode soft bit masks */
  73. #define CACHE_DISABLED 0x00 /* No cache or disabled */
  75. #define CACHE_WRITETHROUGH 0x01 /* Write-through Mode */
  76. #define CACHE_COPYBACK 0x02 /* Copyback Mode */
  77. #define CACHE_WRITEALLOCATE 0x04 /* Write Allocate Mode */
  78. #define CACHE_NO_WRITEALLOCATE 0x08
  79. #define CACHE_SNOOP_ENABLE 0x10 /* Bus Snooping */
  80. #define CACHE_SNOOP_DISABLE 0x20
  81. #define CACHE_BURST_ENABLE 0x40 /* Cache Burst Cycles */
  82. #define CACHE_BURST_DISABLE 0x80
  84. /* Errno values */
  86. #define S_cacheLib_INVALID_CACHE (M_cacheLib | 1)
  88. /* Value for "entire cache" in length arguments */
  90. #define ENTIRE_CACHE ULONG_MAX
  93. #ifndef _ASMLANGUAGE
  95. typedef enum /* CACHE_TYPE */
  96.     {
  97. #if (CPU == MC68060)
  98.     BRANCH_CACHE      = _BRANCH_CACHE,
  99. #endif /* (CPU == MC68060) */
  100. #if (CPU == SH7700)
  101.     WAY2_CACHE        = _WAY2_CACHE,
  102.     WAY3_CACHE        = _WAY3_CACHE,
  103. #endif /* (CPU == SH7700) */
  104.     INSTRUCTION_CACHE = _INSTRUCTION_CACHE,
  105.     DATA_CACHE        = _DATA_CACHE
  106.     } CACHE_TYPE;
  108. typedef UINT CACHE_MODE; /* CACHE_MODE */
  110. typedef struct /* Cache Routine Pointers */
  111.     {
  112.     FUNCPTR enableRtn; /* cacheEnable() */
  113.     FUNCPTR disableRtn; /* cacheDisable() */
  114.     FUNCPTR lockRtn; /* cacheLock() */
  115.     FUNCPTR unlockRtn; /* cacheUnlock() */
  116.     FUNCPTR flushRtn; /* cacheFlush() */
  117.     FUNCPTR invalidateRtn; /* cacheInvalidate() */
  118.     FUNCPTR clearRtn; /* cacheClear() */
  120.     FUNCPTR textUpdateRtn; /* cacheTextUpdate() */
  121.     FUNCPTR pipeFlushRtn; /* cachePipeFlush() */
  122.     FUNCPTR dmaMallocRtn; /* cacheDmaMalloc() */
  123.     FUNCPTR dmaFreeRtn; /* cacheDmaFree() */
  124.     FUNCPTR dmaVirtToPhysRtn; /* virtual-to-Physical Translation */
  125.     FUNCPTR dmaPhysToVirtRtn; /* physical-to-Virtual Translation */
  126.     } CACHE_LIB;
  128. /* Cache flush and invalidate support for general use and drivers */
  130. typedef struct /* Driver Cache Routine Pointers */
  131.     {
  132.     FUNCPTR flushRtn; /* cacheFlush() */
  133.     FUNCPTR invalidateRtn; /* cacheInvalidate() */
  134.     FUNCPTR virtToPhysRtn; /* Virtual-to-Physical Translation */
  135.     FUNCPTR physToVirtRtn; /* Physical-to-Virtual Translation */
  136.     } CACHE_FUNCS;
  139. /* Cache macros */
  141. #define CACHE_TEXT_UPDATE(adrs, bytes)
  142.         ((cacheLib.textUpdateRtn == NULL) ? OK :
  143.  (cacheLib.textUpdateRtn) ((adrs), (bytes)))
  145. #define CACHE_PIPE_FLUSH()
  146.         ((cacheLib.pipeFlushRtn == NULL) ? OK :
  147.  (cacheLib.pipeFlushRtn) ())
  150. #define CACHE_DRV_FLUSH(pFuncs, adrs, bytes)
  151.         (((pFuncs)->flushRtn == NULL) ? OK :
  152.          ((pFuncs)->flushRtn) (DATA_CACHE, (adrs), (bytes)))
  154. #define CACHE_DRV_INVALIDATE(pFuncs, adrs, bytes)
  155.         (((pFuncs)->invalidateRtn == NULL) ? OK :
  156.          ((pFuncs)->invalidateRtn) (DATA_CACHE, (adrs), (bytes)))
  158. #define CACHE_DRV_VIRT_TO_PHYS(pFuncs, adrs)
  159.         (((pFuncs)->virtToPhysRtn == NULL) ? (void *) (adrs) :
  160.  (void *) (((pFuncs)->virtToPhysRtn) (adrs)))
  162. #define CACHE_DRV_PHYS_TO_VIRT(pFuncs, adrs)
  163.         (((pFuncs)->physToVirtRtn == NULL) ? (void *) (adrs) :
  164.  ((void *) ((pFuncs)->physToVirtRtn) (adrs)))
  166. #define CACHE_DRV_IS_WRITE_COHERENT(pFuncs)
  167. ((pFuncs)->flushRtn == NULL)
  169. #define CACHE_DRV_IS_READ_COHERENT(pFuncs)
  170. ((pFuncs)->invalidateRtn == NULL)
  173. #define CACHE_DMA_FLUSH(adrs, bytes)
  174. CACHE_DRV_FLUSH (&cacheDmaFuncs, (adrs), (bytes))
  176. #define CACHE_DMA_INVALIDATE(adrs, bytes)
  177. CACHE_DRV_INVALIDATE (&cacheDmaFuncs, (adrs), (bytes))
  179. #define CACHE_DMA_VIRT_TO_PHYS(adrs)
  180. CACHE_DRV_VIRT_TO_PHYS (&cacheDmaFuncs, (adrs))
  182. #define CACHE_DMA_PHYS_TO_VIRT(adrs)
  183. CACHE_DRV_PHYS_TO_VIRT (&cacheDmaFuncs, (adrs))
  185. #define CACHE_DMA_IS_WRITE_COHERENT()
  186. CACHE_DRV_IS_WRITE_COHERENT (&cacheDmaFuncs)
  188. #define CACHE_DMA_IS_READ_COHERENT()
  189. CACHE_DRV_IS_READ_COHERENT (&cacheDmaFuncs)
  192. #define CACHE_USER_FLUSH(adrs, bytes)
  193. CACHE_DRV_FLUSH (&cacheUserFuncs, (adrs), (bytes))
  195. #define CACHE_USER_INVALIDATE(adrs, bytes)
  196. CACHE_DRV_INVALIDATE (&cacheUserFuncs, (adrs), (bytes))
  198. #define CACHE_USER_IS_WRITE_COHERENT()
  199. CACHE_DRV_IS_WRITE_COHERENT (&cacheUserFuncs)
  201. #define CACHE_USER_IS_READ_COHERENT()
  202. CACHE_DRV_IS_READ_COHERENT (&cacheUserFuncs)
  206. /* variable declarations */
  208. IMPORT CACHE_LIB cacheLib;
  209. IMPORT CACHE_FUNCS cacheNullFuncs; /* functions for non-cached memory */
  210. IMPORT CACHE_FUNCS cacheDmaFuncs; /* functions for dma memory */
  211. IMPORT CACHE_FUNCS cacheUserFuncs; /* functions for user memory */
  213. IMPORT FUNCPTR cacheDmaMallocRtn;
  214. IMPORT FUNCPTR cacheDmaFreeRtn;
  215. IMPORT CACHE_MODE cacheDataMode; /* data cache modes for funcptrs */
  216. IMPORT BOOL cacheDataEnabled;
  217. IMPORT BOOL cacheMmuAvailable;
  219. /* function declarations */
  221. #if defined(__STDC__) || defined(__cplusplus)
  223. extern STATUS cacheLibInit (CACHE_MODE inst, CACHE_MODE data);
  224. #if (CPU_FAMILY != ARM)
  225. extern STATUS cacheArchLibInit (CACHE_MODE inst, CACHE_MODE data);
  226. #endif
  227. extern STATUS cacheEnable (CACHE_TYPE cache);
  228. extern STATUS cacheDisable (CACHE_TYPE cache);
  229. extern STATUS cacheLock (CACHE_TYPE cache, void * adrs, size_t bytes);
  230. extern STATUS cacheUnlock (CACHE_TYPE cache, void * adrs, size_t bytes);
  231. extern STATUS cacheFlush (CACHE_TYPE cache, void * adrs, size_t bytes);
  232. extern STATUS cacheInvalidate (CACHE_TYPE cache, void *adrs, size_t bytes);
  233. extern STATUS cacheClear (CACHE_TYPE cache, void * adrs, size_t bytes);
  234. extern STATUS cacheTextUpdate (void * adrs, size_t bytes);
  235. extern STATUS cachePipeFlush (void);
  237. extern void * cacheDmaMalloc (size_t bytes);
  238. extern STATUS cacheDmaFree (void * pBuf);
  240. extern STATUS cacheDrvFlush (CACHE_FUNCS * pFuncs, void * adrs, size_t bytes);
  241. extern STATUS cacheDrvInvalidate (CACHE_FUNCS * pFuncs, void * adrs,
  242.     size_t bytes);
  243. extern void *   cacheDrvVirtToPhys (CACHE_FUNCS * pFuncs, void * adrs);
  244. extern void *   cacheDrvPhysToVirt (CACHE_FUNCS * pFuncs, void * adrs);
  246. extern void cacheFuncsSet (void);
  248. #else
  250. extern STATUS cacheLibInit ();
  251. #if (CPU_FAMILY != ARM)
  252. extern STATUS cacheArchLibInit ();
  253. #endif
  254. extern STATUS cacheEnable ();
  255. extern STATUS cacheDisable ();
  256. extern STATUS cacheLock ();
  257. extern STATUS cacheUnlock ();
  258. extern STATUS cacheFlush ();
  259. extern STATUS cacheInvalidate ();
  260. extern STATUS cacheClear ();
  261. extern STATUS cacheTextUpdate ();
  262. extern STATUS cachePipeFlush ();
  263. extern void * cacheDmaMalloc ();
  264. extern STATUS cacheDmaFree ();
  265. extern STATUS cacheDrvFlush ();
  266. extern STATUS cacheDrvInvalidate ();
  267. extern void *   cacheDrvVirtToPhys ();
  268. extern void *   cacheDrvPhysToVirt ();
  269. extern void cacheSetFuncs ();
  271. #endif /* __STDC__ */
  273. #endif /* _ASMLANGUAGE */
  275. /* Architecture-specific cache headers */
  277. #if (CPU_FAMILY == MC680X0)
  278. #include "arch/mc68k/cacheMc68kLib.h"
  279. #endif  /* (CPU_FAMILY == MC680X0) */
  281. #if (CPU_FAMILY == COLDFIRE)
  282. #include "arch/coldfire/cacheColdfireLib.h"
  283. #endif  /* (CPU_FAMILY == COLDFIRE) */
  285. #if (CPU_FAMILY == SPARC)
  286. #include "arch/sparc/cacheSparcLib.h"
  287. #endif
  289. #if (CPU_FAMILY == MIPS)
  290. #include "arch/mips/cacheMipsLib.h"
  291. #endif  /* (CPU_FAMILY == MIPS) */
  293. #if (CPU_FAMILY == PPC)
  294. #include "arch/ppc/cachePpcLib.h"
  295. #endif /* CPU_FAMILY == PPC */
  297. #if (CPU_FAMILY == I960)
  298. #include "arch/i960/vxI960Lib.h"
  299. #endif  /* CPU_FAMILY == I960 */
  301. #if (CPU_FAMILY == I80X86)
  302. #include "arch/i86/cacheI86Lib.h"
  303. #endif  /* CPU_FAMILY == I80X86 */
  305. #if (CPU_FAMILY == AM29XXX)
  306. #include "arch/am29k/cacheAm29kLib.h"
  307. #endif  /* CPU_FAMILY == AM29XXX */
  309. #if (CPU_FAMILY == SH)
  310. #include "arch/sh/cacheShLib.h"
  311. #endif /* CPU_FAMILY == SH */
  313. #if     (CPU_FAMILY == ARM)
  314. #include "arch/arm/cacheArmLib.h"
  315. #endif  /* CPU_FAMILY == ARM */
  317. #ifdef __cplusplus
  318. }
  319. #endif
  321. #endif /* __INCcacheLibh */