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

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

VxWorks

开发平台：

C/C++

if_eex.h：源码内容
  1. /* if_eex.h - Intel EtherExpress 16 interface header */
  3. /* Copyright 1990-1993 Wind River Systems, Inc. */
  4. /*
  5. modification history
  6. --------------------
  7. 01d,25jan95,hdn  added RB_OFFSET and RB_LINK for the Simpact's patch.
  8. 01c,20feb94,bcs  relabel, recomment extended control register, define AUTODETECT
  9.  and remove old connector type symbols
  10. 01b,04dec93,bcs  made functional, added AL_LOC compile-time option
  11. 01a,28nov93,bcs  created from if_ei.h (rev. 02h,22sep92)
  12. */
  14. #ifndef __INCif_eexh
  15. #define __INCif_eexh
  17. #ifdef __cplusplus
  18. extern "C" {
  19. #endif
  21. #if ((CPU_FAMILY==I960) && (defined __GNUC__))
  22. #pragma align 1                 /* tell gcc960 not to optimize alignments */
  23. #endif  /* CPU_FAMILY==I960 */
  25. /* constants needed within this file */
  27. #define EEX_AL_LOC                      /* define to use header-in-data */
  28.                                         /* feature of 82586 */
  30. #define EA_SIZE         6
  31. #define EH_SIZE         14              /* avoid structure padding issues */
  32. #define N_MCAST         12
  34. /* Size of frame buffers in this driver
  35.  * Made even to simplify structure alignment in code */
  37. #define FRAME_SIZE      ( ( ETHERMTU + EH_SIZE + 1 ) & ~1 )
  39. /* Intel EtherExpress 16 board port and bit definitions */
  41. /* I/O ports relative to board base port address */
  42. /* Word registers unless otherwise noted */
  44. #define DXREG           0x00            /* Data transfer register */
  45. #define WRPTR           0x02            /* Write address pointer */
  46. #define RDPTR           0x04            /* Read address pointer */
  47. #define CA_CTRL         0x06            /* (byte) Channel Attention */
  48. #define SEL_IRQ         0x07            /* (byte) IRQ select and enable */
  49. #define SMB_PTR         0x08            /* Shadow memory bank pointer */
  50. #define MEMDEC          0x0a            /* (byte) Memory address decode */
  51. #define MEMCTRL         0x0b            /* (byte) Memory mapped control */
  52. #define MEMPC           0x0c            /* (byte) MEMCS16 page control */
  53. #define CONFIG          0x0d            /* (byte) Configuration test */
  54. #define EE_CTRL         0x0e            /* (byte) EEPROM control and reset */
  55. #define MEMECTRL        0x0f            /* (byte) Memory control 0xE000 seg*/
  56. #define AUTOID          0x0f            /* (byte) Auto ID register */
  58. #define ECR1            0x300e          /* (byte) extended control: conn.type */
  59.                                         /* only exists on newer boards */
  60. #define SHADOWID        0x300f          /* (byte) board subtype/rev. */
  62. #define SCB_STATUS      0xc008          /* SCB status word */
  63. #define SCB_COMMAND     0xc00a          /* SCB command word */
  64. #define SCB_CBL         0xc00c          /* SCB command block list head */
  65. #define SCB_RFA         0xc00e          /* SCB received frame area */
  67. /* Register bits and bit masks */
  69. #define IRQ_SEL         0x07            /* SEL_IRQ: interrupt line code bits */
  70. #define IRQ_ENB         0x08            /* SEL_IRQ: interrupt enable */
  72. #define EEPROM_CLOCK    0x01            /* EE_CTRL: Shift clock pin */
  73. #define EEPROM_CHIPSEL  0x02            /* EE_CTRL: Chip select for EEPROM */
  74. #define EEPROM_OUTPUT   0x04            /* EE_CTRL: Data out to EEPROM */
  75. #define EEPROM_INPUT    0x08            /* EE_CTRL: Data in from EEPROM */
  76. #define RESET_ASIC      0x40            /* EE_CTRL: Reset board ASIC */
  77. #define RESET_82586     0x80            /* EE_CTRL: Reset pin of 82586 */
  79. /* defined bits in ECR1 port; leave others alone! */
  81. #define CONN_INTEGRITY  0x02            /* bit in ECR1 to enable */
  82.                                         /* link integrity for RJ-45 */
  83. #define CONN_TRANSCEIVER 0x80           /* write-only bit to enable */
  84.                                         /* on-board transceiver power */
  85.                                         /* for BNC or RJ-45 connection */
  87. /* Hyundai serial EEPROM operation codes */
  89. #define EEPROM_OP_READ  0x06            /* 3 bits, read data */
  90. #define EEPROM_OP_WRITE 0x05            /* 3 bits, write data */
  91. #define EEPROM_OP_ERASE 0x07            /* 3 bits, erase data */
  92. #define EEPROM_OP_EWEN  0x13            /* 5 bits, erase/write enable */
  93. #define EEPROM_OP_EWDIS 0x10            /* 5 bits, erase/write enable */
  95. /* EtherExpress 16 EEPROM memory registers */
  97. #define EEX_EEPROM_SETUP        0       /* I/O, IRQ, AUI setup etc. */
  98. #define EEX_EEPROM_MEMPAGE      1       /* mempage bits, base and select bits */
  99. #define EEX_EEPROM_EA_LOW       2       /* low-order 16 bits of Ethernet addr.*/
  100. #define EEX_EEPROM_EA_MID       3       /* middle 16 bits */
  101. #define EEX_EEPROM_EA_HIGH      4       /* high-order 16 bits */
  102. #define EEX_EEPROM_TPE_BIT      5       /* bit 0 sez if TPE in use */
  103. #define EEX_EEPROM_MEMDECODE    6       /* mem decode bits, page 0xe000 bits */
  105. /* Important bits in the EERPOM words */
  107. #define SETUP_BNC               0x1000  /* set for BNC, clear for AUI/TPE */
  108. #define MEMPAGE_AUTODETECT      0x0080  /* set for auto-detect of attachment */
  109. #define TPE_BIT                 0x0001  /* set for TPE, clear for other */
  111. /* data structure to convert memory setup EEPROM words into register bytes */
  113. typedef union mem_setup
  114.     {
  115.     struct
  116.         {
  117.         UINT16  memPage;                /* from EEX_EEPROM_MEMPAGE */
  118.         UINT16  memDecode;              /* from EEX_EEPROM_MEMDECODE */
  119.         } wordView;
  120.     struct
  121.         {
  122.         UINT8   memCtrl;                /* to MEMCTRL register */
  123.         UINT8   memPC;                  /* to MEMPC register */
  124.         UINT8   memDec;                 /* to MEMDEC register */
  125.         UINT8   memECtrl;               /* to MEMECTRL register */
  126.         } byteView;
  127.     } MEM_SETUP;
  129. /* Intel 82586 endian safe link macros and structure definitions */
  131. #define LINK_WR(pLink,value)                                            
  132.         (((pLink)->lsw = (UINT16)((UINT32)(value) & 0x0000ffff)),       
  133.         ((pLink)->msw  = (UINT16)(((UINT32)(value) >> 16) & 0x0000ffff)))
  135. #define LINK_RD(pLink) ((pLink)->lsw | ((pLink)->msw << 16))
  137. #define STAT_RD LINK_RD                 /* statistic read is a link read */
  138. #define STAT_WR LINK_WR                 /* statistic write is a link write */
  140. typedef UINT16 EEX_SHORTLINK;           /* 82586 "offset" field */
  141. typedef struct eex_link                         /* EEX_LINK - endian resolvable link */
  142.     {
  143.     UINT16              lsw;            /* least significant word */
  144.     UINT16              msw;            /* most significant word */
  145.     } EEX_LINK;
  147. typedef struct eex_node                         /* EEX_NODE - common linked list object */
  148.     {
  149.     UINT16                              field1;
  150.     UINT16                              field2;
  151.     EEX_LINK                            lNext;                                          /* link to next node */
  152.     EEX_LINK                            field4;
  153.     UINT16                              field5;
  154.     UINT16                              field6;
  155.     UINT8                               field7 [EH_SIZE];
  156.     char                                field8 [ETHERMTU];
  157.         struct eex_node         *pNext;                                         /* ptr to next node */
  158.     } EEX_NODE;
  160. typedef UINT16 EEX_STAT;        /* EEX_STAT - 82586 error statistic */
  164. /* Intel 82586 structure and bit mask definitions */
  166. /* System Configuration Pointer and bit field defines */
  168. typedef struct scp              /* SCP - System Configuration Pointer */
  169.     {
  170.     UINT16 scpSysbus;                   /* SYSBUS */
  171.     UINT16 scpRsv1;                     /* reserved */
  172.     UINT16 scpRsv2;                     /* reserved */
  173.     EEX_LINK pIscp;                     /* ISCP address */
  174.     } SCP;
  177. /* Intermediate System Configuration Pointer */
  179. typedef struct iscp             /* ISCP - Intermediate System Config. Ptr. */
  180.     {
  181.     volatile UINT16     iscpBusy;       /* i82586 is being initialized */
  182.     EEX_SHORTLINK       offsetScb;      /* SCB offset */
  183.     EEX_LINK            pScb;           /* SCB address */
  184.     } ISCP;
  187. /* System Control Block and bit field defines */
  189. typedef struct scb              /* SCB - System Control Block */
  190.     {
  191.     volatile UINT16     scbStatus;      /* Status Word */
  192.     volatile UINT16     scbCommand;     /* Command Word */
  193.     EEX_SHORTLINK       pCB;            /* command block address */
  194.     EEX_SHORTLINK       pRF;            /* receive frame area address */
  195.     EEX_STAT            crcErr;         /* CRC error count */
  196.     EEX_STAT            allignErr;      /* frames misaligned and CRC err cnt */
  197.     EEX_STAT            noResErr;       /* no resources error count */
  198.     EEX_STAT            ovErr;          /* overrun error count */
  199.     } SCB;
  201. #define SCB_S_RUMASK    0x00f0          /* state mask */
  202. #define SCB_S_RUIDLE    0x0000          /* RU is idle */
  203. #define SCB_S_RUSUSP    0x0010          /* RU is suspended */
  204. #define SCB_S_RUNORSRC  0x0020          /* RU has no resources */
  205. #define SCB_S_RURSV1    0x0030          /* reserved */
  206. #define SCB_S_RUREADY   0x0040          /* RU is ready */
  207. #define SCB_S_CUMASK    0x0f00          /* state mask */
  208. #define SCB_S_CUIDLE    0x0000          /* CU is idle */
  209. #define SCB_S_CUSUSP    0x0100          /* CU is suspended */
  210. #define SCB_S_CUACTIVE  0x0200          /* CU is active */
  211. #define SCB_S_CURSV1    0x0300          /* reserved */
  212. #define SCB_S_CURSV2    0x0400          /* reserved */
  213. #define SCB_S_CURSV3    0x0500          /* reserved */
  214. #define SCB_S_CURSV4    0x0600          /* reserved */
  215. #define SCB_S_CURSV5    0x0700          /* reserved */
  216. #define SCB_S_XMASK     0xf000          /* state mask */
  217. #define SCB_S_RNR       0x1000          /* RU left the ready state */
  218. #define SCB_S_CNA       0x2000          /* CU left the active state */
  219. #define SCB_S_FR        0x4000          /* RU finished receiveing a frame */
  220. #define SCB_S_CX        0x8000          /* CU finished a cmd with I bit set */
  222. #define SCB_C_RUNOP     0x0000          /* NOP */
  223. #define SCB_C_RUSTART   0x0010          /* start reception of frames */
  224. #define SCB_C_RURESUME  0x0020          /* resume reception of frames */
  225. #define SCB_C_RUSUSPEND 0x0030          /* suspend reception of frames */
  226. #define SCB_C_RUABORT   0x0040          /* abort receiver immediately */
  227. #define SCB_C_RURSV1    0x0050          /* reserved */
  228. #define SCB_C_RURSV2    0x0060          /* reserved */
  229. #define SCB_C_RURSV3    0x0070          /* reserved */
  230. #define SCB_C_RESET     0x0080          /* reset chip */
  231. #define SCB_C_CUNOP     0x0000          /* NOP */
  232. #define SCB_C_CUSTART   0x0100          /* start execution */
  233. #define SCB_C_CURESUME  0x0200          /* resume execution */
  234. #define SCB_C_CUSUSPEND 0x0300          /* suspend execution after cur. cmd */
  235. #define SCB_C_CUABORT   0x0400          /* abort current cmd immediately */
  236. #define SCB_C_CURSV1    0x0700          /* reserved */
  237. #define SCB_C_ACK_RNR   0x1000          /* ACK that RU became not ready */
  238. #define SCB_C_ACK_CNA   0x2000          /* ACK that CU bacame not active */
  239. #define SCB_C_ACK_FR    0x4000          /* ACK that RU received a frame */
  240. #define SCB_C_ACK_CX    0x8000          /* ACK that CU completed an action */
  243. /* Action Command Descriptions */
  245. typedef struct ac_iasetup       /* AC_IASETUP - Individual Address Setup */
  246.     {
  247.     UINT8  ciAddress[EA_SIZE];          /* local ethernet address */
  248.     UINT16 ciFill;
  249.     } AC_IASETUP;
  251. typedef struct ac_config        /* AC_CONFIG - i82586 Configure */
  252.     {
  253.     UINT8 byteCount;                    /* byte count */
  254.     UINT8 fifoLimit;                    /* FIFO limit */
  255.     UINT8 srdy_saveBad;                 /* SRD/~ARDY, save bad frames */
  256.     UINT8 addrLen_loopback;             /* address length, loopback */
  257.     UINT8 backoff;                      /* backoff method */
  258.     UINT8 interframe;                   /* interframe spacing */
  259.     UINT8 slotTimeLow;                  /* slot time -low byte */
  260.     UINT8 slotTimeHi_retry;             /* slot time -upper 3 bits, max retry */
  261.     UINT8 promiscuous;                  /* promiscuous mode, other stuff */
  262.     UINT8 carrier_collision;            /* carrier sense, collision detect */
  263.     UINT8 minFrame;                     /* minimum frame length */
  264.     UINT8 notUsed;
  265.     UINT16 ccFill;
  266.     } AC_CONFIG;
  268. typedef struct ac_mcast         /* AC_MCAST - Multicast Setup */
  269.     {
  270.     UINT16 cmMcCount;                   /* the number of bytes in MC list */
  271.     UINT8  cmAddrList[6 * N_MCAST];     /* mulitcast address list */
  272.     } AC_MCAST;
  274. typedef struct ac_tdr           /* AC_TDR - Time Domain Reflectometry */
  275.     {
  276.     UINT16 ctInfo;                      /* time, link OK, tx err, line err */
  277.     UINT16 ctReserve1;                  /* reserved */
  278.     } AC_TDR;
  280. typedef struct ac_dump          /* AC_DUMP - Dump */
  281.     {
  282.     EEX_SHORTLINK bufAddr;              /* address of dump buffer */
  283.     } AC_DUMP;
  286. /* Command Frame Description and defines */
  288. typedef struct cfd              /* CFD - Command Frame Descriptor */
  289.     {
  290.     volatile UINT16     cfdStatus;      /* command status */
  291.     UINT16              cfdCommand;     /* command */
  292.     EEX_SHORTLINK       link;           /* address of next CB */
  293.     union                               /* command dependent section */
  294.         {
  295.         struct ac_iasetup       cfd_iasetup;    /* IA setup */
  296.         struct ac_config        cfd_config;     /* config */
  297.         struct ac_mcast         cfd_mcast;      /* multicast setup */
  298.         struct ac_tdr           cfd_tdr;        /* TDR */
  299.         struct ac_dump          cfd_dump;       /* dump */
  300.         } cfd_cmd;
  301.     } CFD;
  303. #define cfdIASetup      cfd_cmd.cfd_iasetup
  304. #define cfdConfig       cfd_cmd.cfd_config
  305. #define cfdMcast        cfd_cmd.cfd_mcast
  306. #define cfdTransmit     cfd_cmd.cfd_transmit
  307. #define cfdTDR          cfd_cmd.cfd_tdr
  308. #define cfdDump         cfd_cmd.cfd_dump
  310. #define CFD_C_NOP       0x0000          /* No Operation */
  311. #define CFD_C_IASETUP   0x0001          /* Individual Address Setup */
  312. #define CFD_C_CONFIG    0x0002          /* Configure Chip */
  313. #define CFD_C_MASETUP   0x0003          /* Multicast Setup */
  314. #define CFD_C_XMIT      0x0004          /* Transmit (see below too ...) */
  315. #define CFD_C_TDR       0x0005          /* Time Domain Reflectometry */
  316. #define CFD_C_DUMP      0x0006          /* Dump Registers */
  317. #define CFD_C_DIAG      0x0007          /* Diagnose */
  318. #define CFD_C_INT       0x2000          /* 586 interrupts CPU after execution */
  319. #define CFD_C_SE        0x4000          /* CU should suspend after execution */
  320. #define CFD_C_EL        0x8000          /* End of command list */
  322. #define CFD_S_ABORTED   0x1000          /* Command was aborted via CU Abort */
  323. #define CFD_S_OK        0x2000          /* Command completed successfully */
  324. #define CFD_S_BUSY      0x4000          /* CU is executing this command */
  325. #define CFD_S_COMPLETE  0x8000          /* Command complete */
  328. /* 82586 Transmit/Receive Frames */
  330. typedef struct tfd              /* TFD - Transmit Frame Descriptor */
  331.     {
  332.     volatile UINT16     status;                 /* status field */
  333.     UINT16              command;                /* command field */
  334.     EEX_SHORTLINK       lNext;                  /* link to next desc. */
  335.     EEX_SHORTLINK       lBufDesc;               /* link to buf desc. */
  336.     } TFD;
  338. /* special TFD specific command block bit masks */
  340. #define CFD_S_COLL_MASK 0x000f          /* to access number of collisions */
  341. #define CFD_S_RETRY     0x0020          /* reached the max number of retries */
  342. #define CFD_S_HBEAT     0x0040          /* Heartbeat Indicator */
  343. #define CFD_S_TRDEF     0x0080          /* Transmission Deferred */
  344. #define CFD_S_DMA_UNDR  0x0100          /* DMA Underrun (no data) */
  345. #define CFD_S_NO_CTS    0x0200          /* Lost Clear To Send signal */
  346. #define CFD_S_NO_CRS    0x0400          /* No Carrier Sense */
  349. typedef struct tbd              /* TBD - Transmit Buffer Descriptor */
  350.     {
  351.     volatile UINT16     actCount;       /* Actual byte count */
  352.     EEX_SHORTLINK       lNext;          /* Address of next buffer descr. */
  353.     EEX_LINK            lBufAddr;       /* Address of this data buffer */
  354.     } TBD;
  356. /* TBD bits */
  358. #define ACT_COUNT_MASK  ~0xc000         /* length fields are 14 bits */
  359. #define TBD_S_EOF       0x8000          /* End-of-frame bit */
  361. #ifdef  EEX_AL_LOC
  362. typedef struct tframe           /* TFRAME - all-in-one transmit frame */
  363.     {
  364.     TFD                 tfd;
  365.     TBD                 tbd;
  366.     char                buffer [FRAME_SIZE];
  367.     } TFRAME;
  368. #else
  369. typedef struct tframe           /* TFRAME - all-in-one transmit frame */
  370.     {
  371.     TFD                 tfd;
  372.     union
  373.         {
  374.         struct
  375.             {
  376.             char                header [EH_SIZE];
  377.             char                data [ETHERMTU];
  378.             } buff_struct;
  379.         char                buffer [FRAME_SIZE];
  380.         } buff_union;
  381.     TBD                 tbd;
  382.     } TFRAME;
  383. #endif  /* EEX_AL_LOC */
  386. typedef struct rfd              /* RFD - Receive Frame Descriptor */
  387.     {
  388.     volatile UINT16     status;                 /* status field */
  389.     UINT16              command;                /* command field */
  390.     EEX_SHORTLINK       lNext;                  /* link to next desc. */
  391.     EEX_SHORTLINK       lBufDesc;               /* link to buf desc. */
  392.     } RFD;
  394. /* RFD bit masks */
  396. #define RFD_S_EOP       0x0040          /* no EOP flag */
  397. #define RFD_S_SHORT     0x0080          /* fewer bytes than configured min. */
  398. #define RFD_S_DMA       0x0100          /* DMA Overrun failure to get bus */
  399. #define RFD_S_RSRC      0x0200          /* received, but ran out of buffers */
  400. #define RFD_S_ALGN      0x0400          /* received misaligned with CRC error */
  401. #define RFD_S_CRC       0x0800          /* received with CRC error */
  402. #define RFD_S_OK        0x2000          /* frame received successfully */
  403. #define RFD_S_BUSY      0x4000          /* frame reception ready/in progress */
  404. #define RFD_S_COMPLETE  0x8000          /* frame reception complete */
  406. #define RFD_M_SUSPEND   0x4000          /* suspend RU after receiving frame */
  407. #define RFD_M_EL        0x8000          /* end of RFD list */
  409. typedef struct rbd              /* RBD - Receive Buffer Descriptor */
  410.     {
  411.     volatile UINT16     actCount;       /* Actual byte count */
  412.     EEX_SHORTLINK       lNext;          /* Address of next buffer descr. */
  413.     EEX_LINK            lBufAddr;       /* Address of this data buffer */
  414.     UINT16              bufSize;        /* Size of data buffer */
  415.     } RBD;
  417. #define RBD_S_CNT_MASK  0x3fff          /* Mask for actual byte count */
  418. #define RBD_S_F_BIT     0x4000          /* actual count is valid */
  419. #define RBD_S_EOF       0x8000          /* end of frame */
  421. #define RBD_M_EL        0x8000          /* end of RBD list */
  423. #ifdef  EEX_AL_LOC
  424. typedef struct rframe           /* RFRAME - all-in-one received frame */
  425.     {
  426.     RFD                 rfd;
  427.     RBD                 rbd;
  428.     char                buffer [FRAME_SIZE];
  429.     } RFRAME;
  430. #else
  431. typedef struct rframe           /* RFRAME - all-in-one received frame */
  432.     {
  433.     RFD                 rfd;
  434.     union
  435.         {
  436.         struct
  437.             {
  438.             char                header [EH_SIZE];
  439.             char                data [ETHERMTU];
  440.             } buff_struct;
  441.         char                buffer [FRAME_SIZE];
  442.         } buff_union;
  443.     RBD                 rbd;
  444.     } RFRAME;
  445. #endif  /* EEX_AL_LOC */
  447. /* Offsets into xFRAME structures to compute board emmory offsets */
  449. #define RF_COMMAND      2               /* command word */
  450. #define RF_LINK         4               /* link to next RFD */
  452. #define RB_OFFSET       6               /* dhe 10/24/94 offset of first RBD */
  453. #define RB_LINK         2               /* dhe 10/24/94 link to next RBD */
  455. #ifdef  EEX_AL_LOC
  456. #define RF_ACT_COUNT    8               /* actual count in RBD */
  457. #define RF_BUFFER       18              /* frame data buffer */
  458. #else
  459. #define RF_BUFFER       8               /* frame data buffer */
  460. #define RF_ACT_COUNT    (RF_BUFFER + FRAME_SIZE)
  461. #endif  /* EEX_AL_LOC */
  463. #define TF_COMMAND      2               /* command word */
  464. #define TF_LINK         4               /* link to next TFD */
  466. #ifdef  EEX_AL_LOC
  467. #define TF_ACT_COUNT    8               /* actual count in TBD */
  468. #define TF_BUFFER       16              /* frame data buffer */
  469. #else
  470. #define TF_BUFFER       8               /* frame header starts here */
  471. #define TF_OLDLENGTH    20              /* Take length from here */
  472. #define TF_NEWLENGTH    14              /* put it here to be part of TFD */
  473. #define TF_ACT_COUNT    (RF_BUFFER + FRAME_SIZE)
  474. #endif  /* EEX_AL_LOC */
  476. #if ((CPU_FAMILY==I960) && (defined __GNUC__))
  477. #pragma align 0                 /* turn off alignment requirement */
  478. #endif  /* CPU_FAMILY==I960 */
  480. #ifdef __cplusplus
  481. }
  482. #endif
  484. #endif /* __INCif_eexh */