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

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

VxWorks

开发平台：

C/C++

smLib.h：源码内容
  1. /* smLib.h - include file for VxWorks shared memory common library */
  3. /* Copyright 1984-2002 Wind River Systems, Inc. */
  4. /*
  5. modification history
  6. --------------------
  7. 01t,05mar02,mas  added SM_MAX_WAIT (SPR 73371)
  8. 01s,14nov01,mas  added smLibInit() prototype for future common code base
  9. 01r,16mar99,dat  added SM_INT_USER_1/2 (SPR 25804)
  10. 01q,29jan93,pme  changed SM_ALIGN_BOUNDARY to 16.
  11. 01p,22sep92,rrr  added support for c++
  12. 01o,12sep92,ajm  moved previously redundant define DEFAULT_BEATS_TO_WAIT from
  13.  smObjLib.h, and smPktLib.h
  14. 01n,28jul92,pme  added SM_ALIGN_BOUNDARY.
  15. 01m,24jul92,elh  Moved heartbeat from anchor.
  16. 01l,19jul92,pme  added external declaration of smCurMaxTries.
  17. 01k,23jun92,elh  added SM_ constants from if_bp, cleanup.
  18. 01j,22jun92,rrr  fix decl of smLibInit when __STDC__ is not defined
  19. 01i,02jun92,elh  the tree shuffle
  20. 01h,28may92.elh  General clean up.
  21. 01g,20may92,pme+ Split even further.  Removed USE_OFFSET.
  22.     elh  Moved pkt specific stuff to smPktLib.h.
  23. 01f,13may92,pme  Added smObjHeaderAdrs fields to anchor.
  24. 01e,03may92,elh  Added smNetReserved fields to anchor.
  25. 01d,01apr92,elh  Removed references to shMemHwTasFunc and
  26.  shMemIntGenFunc (now in smUtilLib).
  27.  Removed interrupt types.
  28. 01c,04feb92,elh  ansified
  29. 01b,17dec91,elh  externed hooks, added ifdef around file, changed VOID
  30.  to void.  Added masterCpu, user1 and user2, to SM_ANCHOR.
  31.  Added S_shMemLib_MEMORY_ERROR. Changed copyright.
  32. 01a,15aug90,kdl  written.
  33. */
  35. #ifndef __INCsmLibh
  36. #define __INCsmLibh
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  42. /* includes */
  44. #include "vwModNum.h"
  47. /* defines */
  49. /* Error codes */
  51. #define S_smLib_MEMORY_ERROR (M_smLib | 1)
  52. #define S_smLib_INVALID_CPU_NUMBER (M_smLib | 2)
  53. #define S_smLib_NOT_ATTACHED (M_smLib | 3)
  54. #define S_smLib_NO_REGIONS (M_smLib | 4)
  56. /* Miscellaneous Constants */
  58. #define SM_READY ((UINT) 0x87654321)
  59. /* value set in anchor when init'd */
  60. #define SM_MASTER 0 /* default CPU 0 is master */
  62. #define SM_ALIGN_BOUNDARY    16  /* shared memory address alignement */
  64. /* default values */
  66. #define SM_REGIONS_MAX 20 /* max number of regions */
  67. #define DEFAULT_ALIVE_TIMEOUT 600 /* default seconds to wait for h'beat */
  68. #define DEFAULT_BEATS_TO_WAIT   5       /* beats to wait 'til believe sm dead */
  69. #define SM_MAX_WAIT 3000 /* max ticks to wait for master boot */
  71. /* Test-and-set type values */
  73. #define SM_TAS_SOFT 0 /* software test-and-set */
  74. #define SM_TAS_HARD 1 /* hardware test-and-set */
  76. /* CPU status values */
  78. #define SM_CPU_ATTACHED        1 /* cpu attached to shared mem */
  79. #define SM_CPU_NOT_ATTACHED    0 /* cpu not attached */
  81. /* backplane interrupt methods */
  83. #define SM_INT_NONE 0 /* no interrupt - poll instead */
  85. /* mailbox write interrupts */
  86. #define SM_INT_MAILBOX_1 1 /* write byte      */
  87. #define SM_INT_MAILBOX_2 2 /* write word      */
  88. #define SM_INT_MAILBOX_4 3 /* write long      */
  90. /* arg1 = bus address space
  91.  * arg2 = bus address
  92.  * arg3 = value
  93.  */
  95. #define SM_INT_BUS 4 /* vme bus interrupt       */
  96. /*    arg1 = interrupt level
  97.  *    arg2 = interrupt vector
  98.  *    arg3 = N/A
  99.  */
  101. /* mailbox read interrupts    */
  102. /*    arg1 = bus address space
  103.  *    arg2 = bus address
  104.  *    arg3 = value
  105.  */
  106. #define SM_INT_MAILBOX_R1 5 /* read byte  */
  107. #define SM_INT_MAILBOX_R2 6 /* read word  */
  108. #define SM_INT_MAILBOX_R4 7 /* read long  */
  110. #define SM_INT_USER_1 8 /* User defined proc #1 */
  111. /* (smUtilUser1Rtn)(arg1,arg2,arg3)*/
  112. #define SM_INT_USER_2 9 /* User defined proc #2 */
  113. /* (smUtilUser2Rtn)(arg1,arg2,arg3)*/
  115. #define SM_OFFSET_TO_LOCAL(offset , baseAddr, typeCast) 
  116. ((typeCast) ((char *) offset +  baseAddr))
  118. #define SM_LOCAL_TO_OFFSET(localAdrs, baseAddr) 
  119. ((int) ((char *) localAdrs - baseAddr))
  122. /* typedefs */
  124. #ifndef _ASMLANGUAGE
  126. #if ((CPU_FAMILY==I960) && (defined __GNUC__))
  127. #pragma align 1                 /* tell gcc960 not to optimize alignments */
  128. #endif  /* CPU_FAMILY==I960 */
  130. /* CPU Descriptor */
  132. typedef struct sm_cpu_desc /* SM_CPU_DESC */
  133.     {
  134.     int status; /* CPU status - attached/unattached */
  135.     int intType; /* interrupt type */
  136.     int intArg1; /* interrupt argument #1 */
  137.     int intArg2; /* interrupt argument #2 */
  138.     int intArg3; /* interrupt argument #3 */
  139.     int reserved1; /* (future use) */
  140.     int reserved2; /* (future use) */
  141.     } SM_CPU_DESC;
  144. /* Shared Memory Header */
  146. typedef struct sm_hdr /* SM_HDR */
  147.     {
  148.     int tasType; /* test-and-set type (test-and-set-and-check?)*/
  149.     int maxCpus; /* maximum number of CPU's in table */
  150.     int cpuTable; /* CPU descriptor table (offset) */
  151.     int reserved1; /* (future use) */
  152.     int reserved2; /* (future use) */
  153.     int reserved3; /* (future use) */
  154.     int reserved4; /* (future use) */
  155.     int reserved5; /* (future use) */
  156.     int reserved6; /* (future use) */
  157.     int reserved7; /* (future use) */
  158.     int reserved8; /* (future use) */
  159.     } SM_HDR;
  162. /* Shared Memory Anchor */
  164. typedef struct sm_anchor /* SM_ANCHOR */
  165.     {
  166.     UINT readyValue;     /* set to SM_READY when sh mem init'd */
  167.     int version;        /* version number */
  168.     int masterCpu;      /* shared memory master */
  169.     int smHeader; /* offset of shared mem header */
  170.     int smPktHeader;    /* offset of smPkt header */
  171.     int  smObjHeader;    /* offset of smObj header */
  172.     int user1;          /* user defined space 1 */
  173.     int user2;          /* user defined space 2 */
  174.     int reserved1;      /* (future use) */
  175.     int reserved2;      /* (future use) */
  176.     int reserved3;      /* (future use) */
  177.     } SM_ANCHOR;
  179. /* Shared Memory Descriptor (maintained by each CPU) */
  181. typedef struct sm_desc /* SM_DESC */
  182.     {
  183.     int status; /* cpu status (attached/not attached) */
  184.     SM_ANCHOR *anchorLocalAdrs;/* local addr of sh mem anchor */
  185.     SM_HDR *headerLocalAdrs;/* local addr of sh mem header */
  186.     SM_CPU_DESC *cpuTblLocalAdrs;/* local addr of cpu descriptor tbl */
  187.     int base; /* base address */
  188.     int cpuNum; /* this CPU's number */
  189.     int ticksPerBeat; /* cpu ticks per sh mem heartbeat */
  190.     int intType; /* interrupt type */
  191.     int intArg1; /* interrupt argument #1 */
  192.     int intArg2; /* interrupt argument #2 */
  193.     int intArg3; /* interrupt argument #3 */
  194.     int maxCpus; /* max number of CPU's using sh mem */
  195.     FUNCPTR tasRoutine; /* addr of TAS routine to use */
  196.     FUNCPTR tasClearRoutine;/* addr of TAS clear routine to use */
  197.     } SM_DESC;
  200. /* Shared Memory Information Structure */
  202. typedef struct sm_info /* SM_INFO */
  203.     {
  204.     int version; /* shared memory protocol version */
  205.     int tasType; /* test-and-set method */
  206.     int maxCpus; /* maximum number of cpu's */
  207.     int attachedCpus; /* number of cpu's currently attached */
  208.     } SM_INFO;
  211. /* CPU Information Structure */
  213. typedef struct sm_cpu_info /* SM_CPU_INFO */
  214.     {
  215.     int cpuNum; /* cpu number */
  216.     int status; /* cpu status - attached/unattached */
  217.     int intType; /* interrupt type */
  218.     int intArg1; /* interrupt argument #1 */
  219.     int intArg2; /* interrupt argument #2 */
  220.     int intArg3; /* interrupt argument #3 */
  221.     } SM_CPU_INFO;
  223. typedef struct sm_region /* shared memory region */
  224.     {
  225.     SM_ANCHOR * anchor; /* shared memory anchor */
  226.     } SM_REGION;
  228. #if ((CPU_FAMILY==I960) && (defined __GNUC__))
  229. #pragma align 0                 /* turn off alignment requirement */
  230. #endif  /* CPU_FAMILY==I960 */
  232. /* Variable Declaration */
  234. extern int smCurMaxTries;    /* current maximum # of tries to get lock */
  235. extern VOIDFUNCPTR smUtilTasClearRtn;
  236. extern FUNCPTR smUtilUser1Rtn;
  237. extern FUNCPTR smUtilUser2Rtn;
  239. /* Function Declarations */
  241. #if defined(__STDC__) || defined(__cplusplus)
  243. extern void smLibInit (void * pRgnCfgTbl, UINT objSize, UINT netSize);
  244. extern STATUS  smSetup (SM_ANCHOR *anchorLocalAdrs, char *smLocalAdrs,
  245.  int tasType, int maxCpus, int * pMemUsed);
  246. extern STATUS smAttach (SM_DESC *pSmDesc);
  247. extern STATUS  smDetach (SM_DESC *pSmDesc);
  248. extern void  smInit (SM_DESC *pSmDesc, SM_ANCHOR *anchorLocalAdrs,
  249. int ticksPerBeat, int intType, int intArg1,
  250. int intArg2, int intArg3);
  251. extern BOOL  smIsAlive (SM_ANCHOR *pAnchor, int *pHeader, int base,
  252.    int heartBeats, int ticksPerBeat);
  253. extern STATUS  smLockTake (int * lockLocalAdrs, FUNCPTR tasRoutine,
  254.    int numTries, int * pOldLvl);
  255. extern void smLockGive (int *lockLocalAdrs, FUNCPTR tasClearRoutine,
  256.     int oldLvl);
  257. extern STATUS  smInfoGet (SM_DESC *pSmDesc, SM_INFO *pInfo);
  258. extern STATUS  smCpuInfoGet (SM_DESC *pSmDesc, int cpuNum,
  259.       SM_CPU_INFO *pCpuInfo);
  262. #else /* __STDC__ */
  264. extern void smLibInit ();
  265. extern STATUS  smSetup ();
  266. extern STATUS smAttach ();
  267. extern STATUS  smDetach ();
  268. extern void smInit ();
  269. extern BOOL  smIsAlive ();
  270. extern STATUS  smLockTake ();
  271. extern void smLockGive ();
  272. extern STATUS  smInfoGet ();
  273. extern STATUS  smCpuInfoGet ();
  275. #endif /* __STDC__ */
  277. #endif  /* _ASMLANGUAGE */
  279. #ifdef __cplusplus
  280. }
  281. #endif
  283. #endif /* __INCsmLibh */