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

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

VxWorks

开发平台：

C/C++

miiLib.h：源码内容
  1. /* miiLib.h - Media Independent Interface library header */
  3. /* Copyright 1990-2002 Wind River Systems, Inc. */
  4. /*
  5. modification history
  6. --------------------
  7. 01i,13may02,rcs added pPhyOptRegsRtn field to PHY_INFO. SPR# 76711
  8. 01h,14jun01,rcs moved new registers used by GMII to new struc MII_G_REGS 
  9.                 and placed it at end of PHY_INFO. (SPR# 68502) 
  10. 01g,23feb01,jln add basic GMII support for 1000-T auto-negotiation (SPR# 68502)
  11. 01f,23nov99,cn  added miiLibInit () to make miiLib a component (SPR #29542).
  12. 01e,08nov99,cn  added fields phyLinkDownRtn, pMiiPhyNode, miiPhyPresent
  13. to PHY_INFO structure. New flags MII_ALL_BUS_SCAN,
  14. MII_PHY_MONITOR, and macro MII_MONITOR_DELAY. Also 
  15. added miiPhyUnInit (), miiLibUnInit ().
  16. 01d,27sep99,cn  added definition of MII_CR_DEF_0_MASK.
  17. 01c,13sep99,cn  added definition of MII_MAX_REG_NUM, moved global APIs
  18. from miiLib.c (SPR# 28305).
  19. 01b,15jun99,cn changes after the code review.
  20. 01a,16mar99,cn written from motFccEnd.h, 01b.
  21. */
  23. /*
  24. DESCRIPTION
  25.  
  26. This module implements a Media Independent Interface (MII) library.
  28. INCLUDE FILES:
  29. */
  31. #ifndef __INCmiiLibh
  32. #define __INCmiiLibh
  34. /* includes */
  36. #ifdef __cplusplus
  37. extern "C" {
  38. #endif
  40. #define S_miiLib_PHY_LINK_DOWN (M_miiLib | 1)
  41. #define S_miiLib_PHY_NULL         (M_miiLib | 2)
  42. #define S_miiLib_PHY_NO_ABLE              (M_miiLib | 3)
  43. #define S_miiLib_PHY_AN_FAIL              (M_miiLib | 4)
  45. /* defines */
  47. #define MII_SYS_DELAY(delay)
  48. if (pPhyInfo->phyDelayRtn != NULL)
  49.     ((* (pPhyInfo->phyDelayRtn)) (delay))
  51. #define MII_READ(addr, reg, val1, val2)
  52.     val2 = ((* (pPhyInfo->phyReadRtn)) ((pPhyInfo->pDrvCtrl), 
  53. (addr), (reg), (val1)));
  55. #define MII_WRITE(addr, reg, val1, val2)
  56.     val2 = ((* (pPhyInfo->phyWriteRtn)) ((pPhyInfo->pDrvCtrl), 
  57. (addr), (reg), (val1)));
  59. /* library flags */
  60.  
  61. #define MII_PHY_FLAGS_SET(setBits)                                      
  62.     (pPhyInfo->phyFlags |= (setBits))
  63.  
  64. #define MII_PHY_FLAGS_ARE_SET(setBits)                                  
  65.     (pPhyInfo->phyFlags & (setBits))
  66.  
  67. #define MII_PHY_FLAGS_GET(setBits)                                      
  68.     (pPhyInfo->phyFlags)
  69.  
  70. #define MII_PHY_FLAGS_CLEAR(clearBits)                                  
  71.     (pPhyInfo->phyFlags &= ~(clearBits))
  72.  
  73. /* MII definitions */
  75. #define MII_CRC_LEN 0x4 /* CRC length in bytes */
  76. #define MII_ETH_MAX_PCK_SZ      (ETHERMTU + SIZEOF_ETHERHEADER          
  77.  + MII_CRC_LEN)
  78. #define MII_MAX_PHY_NUM 0x20 /* max number of attached PHYs */
  79. #define MII_MAX_REG_NUM         0x20    /* max number of registers */
  81. #define MII_CTRL_REG 0x0 /* Control Register */
  82. #define MII_STAT_REG 0x1 /* Status Register */
  83. #define MII_PHY_ID1_REG 0x2 /* PHY identifier 1 Register */
  84. #define MII_PHY_ID2_REG 0x3 /* PHY identifier 2 Register */
  85. #define MII_AN_ADS_REG 0x4 /* Auto-Negotiation    */
  86. /* Advertisement Register */
  87. #define MII_AN_PRTN_REG 0x5 /* Auto-Negotiation      */
  88. /* partner ability Register */
  89. #define MII_AN_EXP_REG 0x6 /* Auto-Negotiation   */
  90. /* Expansion Register */
  91. #define MII_AN_NEXT_REG 0x7 /* Auto-Negotiation         */
  92. /* next-page transmit Register */
  94. #define MII_AN_PRTN_NEXT_REG 0x8  /* Link partner received next page */ 
  95. #define MII_MASSLA_CTRL_REG 0x9  /* MATER-SLAVE control register */
  96. #define MII_MASSLA_STAT_REG 0xa  /* MATER-SLAVE status register */
  97. #define MII_EXT_STAT_REG 0xf  /* Extented status register */
  99. /* MII control register bit  */
  101. #define MII_CR_COLL_TEST 0x0080 /* collision test */
  102. #define MII_CR_FDX 0x0100 /* FDX =1, half duplex =0 */
  103. #define MII_CR_RESTART 0x0200 /* restart auto negotiation */
  104. #define MII_CR_ISOLATE 0x0400 /* isolate PHY from MII */
  105. #define MII_CR_POWER_DOWN 0x0800 /* power down */
  106. #define MII_CR_AUTO_EN 0x1000 /* auto-negotiation enable */
  107. #define MII_CR_100 0x2000 /* 0 = 10mb, 1 = 100mb */
  108. #define MII_CR_LOOPBACK 0x4000 /* 0 = normal, 1 = loopback */
  109. #define MII_CR_RESET 0x8000 /* 0 = normal, 1 = PHY reset */
  110. #define MII_CR_NORM_EN 0x0000 /* just enable the PHY */
  111. #define MII_CR_DEF_0_MASK       0xca7f          /* they must return zero */
  112. #define MII_CR_RES_MASK        0x003f          /* reserved bits,return zero */
  114. /* MII Status register bit definitions */
  116. #define MII_SR_LINK_STATUS 0x0004        /* link Status -- 1 = link */
  117. #define MII_SR_AUTO_SEL 0x0008        /* auto speed select capable */
  118. #define MII_SR_REMOTE_FAULT     0x0010       /* Remote fault detect */
  119. #define MII_SR_AUTO_NEG         0x0020       /* auto negotiation complete */
  120. #define MII_SR_10T_HALF_DPX     0x0800      /* 10BaseT HD capable */
  121. #define MII_SR_10T_FULL_DPX     0x1000     /* 10BaseT FD capable */
  122. #define MII_SR_TX_HALF_DPX      0x2000     /* TX HD capable */
  123. #define MII_SR_TX_FULL_DPX      0x4000      /* TX FD capable */
  124. #define MII_SR_T4               0x8000     /* T4 capable */
  125. #define MII_SR_ABIL_MASK        0xff80     /* abilities mask */
  126. #define MII_SR_EXT_CAP          0x0001     /* extended capabilities */
  128. /*  MII ID2 register bit mask */
  130. #define MII_ID2_REVISON_MASK    0x000f
  131. #define MII_ID2_MODE_MASK       0x03f0
  133. /* MII AN advertisement Register bit definition */
  135. #define MII_ANAR_10TX_HD        0x0020
  136. #define MII_ANAR_10TX_FD        0x0040
  137. #define MII_ANAR_100TX_HD       0x0080
  138. #define MII_ANAR_100TX_FD       0x0100
  139. #define MII_ANAR_100T_4         0x0200
  140. #define MII_ANAR_PAUSE          0x0400
  141. #define MII_ANAR_ASM_PAUSE      0x0800
  142. #define MII_ANAR_REMORT_FAULT   0x2000
  143. #define MII_ANAR_NEXT_PAGE      0x8000
  144. #define MII_ANAR_PAUSE_MASK     0x0c00
  146. /* MII Link Code word  bit definitions */
  148. #define MII_BP_FAULT 0x2000        /* remote fault */
  149. #define MII_BP_ACK 0x4000        /* acknowledge */
  150. #define MII_BP_NP 0x8000        /* nexp page is supported */
  152. /* MII Next Page bit definitions */
  154. #define MII_NP_TOGGLE 0x0800        /* toggle bit */
  155. #define MII_NP_ACK2 0x1000        /* acknowledge two */
  156. #define MII_NP_MSG 0x2000        /* message page */
  157. #define MII_NP_ACK1 0x4000        /* acknowledge one */
  158. #define MII_NP_NP 0x8000        /* nexp page will follow */
  160. /* MII Expansion Register bit definitions */
  162. #define MII_EXP_FAULT 0x0010        /* parallel detection fault */
  163. #define MII_EXP_PRTN_NP 0x0008        /* link partner next-page able */
  164. #define MII_EXP_LOC_NP 0x0004        /* local PHY next-page able */
  165. #define MII_EXP_PR 0x0002        /* full page received */
  166. #define MII_EXP_PRT_AN 0x0001        /* link partner auto negotiation able */
  168. /* MII Master-Slave Control register bit definition */
  170. #define MII_MASSLA_CTRL_1000T_HD    0x100
  171. #define MII_MASSLA_CTRL_1000T_FD    0x200
  172. #define MII_MASSLA_CTRL_PORT_TYPE   0x400
  173. #define MII_MASSLA_CTRL_CONFIG_VAL  0x800
  174. #define MII_MASSLA_CTRL_CONFIG_EN   0x1000
  176. /* MII Master-Slave Status register bit definition */
  178. #define MII_MASSLA_STAT_LP1000T_HD  0x400
  179. #define MII_MASSLA_STAT_LP1000T_FD  0x800
  180. #define MII_MASSLA_STAT_REMOTE_RCV  0x1000
  181. #define MII_MASSLA_STAT_LOCAL_RCV   0x2000
  182. #define MII_MASSLA_STAT_CONF_RES    0x4000
  183. #define MII_MASSLA_STAT_CONF_FAULT  0x8000
  185. /* MII Extented Status register bit definition */
  187. #define MII_EXT_STAT_1000T_HD       0x1000
  188. #define MII_EXT_STAT_1000T_FD       0x2000
  189. #define MII_EXT_STAT_1000X_HD       0x4000
  190. #define MII_EXT_STAT_1000X_FD       0x8000
  192. /* technology ability field bit definitions */
  194. #define MII_TECH_10BASE_T 0x0020 /* 10Base-T */
  195. #define MII_TECH_10BASE_FD 0x0040 /* 10Base-T Full Duplex */
  196. #define MII_TECH_100BASE_TX 0x0080 /* 100Base-TX */
  197. #define MII_TECH_100BASE_TX_FD 0x0100 /* 100Base-TX Full Duplex */
  198. #define MII_TECH_100BASE_T4 0x0200 /* 100Base-T4 */
  200. #define MII_TECH_PAUSE 0x0400  /* PAUSE */
  201. #define MII_TECH_ASM_PAUSE 0x0800  /* Asym pause */
  202. #define MII_TECH_PAUSE_MASK 0x0c00 
  204. #define MII_ADS_TECH_MASK 0x1fe0 /* technology abilities mask */
  205. #define MII_TECH_MASK MII_ADS_TECH_MASK
  206. #define MII_ADS_SEL_MASK 0x001f /* selector field mask */
  208. #define MII_AN_FAIL             0x10    /* auto-negotiation fail */
  209. #define MII_STAT_FAIL           0x20    /* errors in the status register */
  210. #define MII_PHY_NO_ABLE      0x40    /* the PHY lacks some abilities */
  212. /* MII management frame structure */
  214. #define MII_MF_PREAMBLE 0xffffffff /* preamble pattern */
  215. #define MII_MF_ST 0x1 /* start of frame pattern */
  216. #define MII_MF_OP_RD 0x2 /* read operation pattern */
  217. #define MII_MF_OP_WR 0x1 /* write operation pattern */
  219. #define MII_MF_PREAMBLE_LEN 0x20 /* preamble lenght in bit */
  220. #define MII_MF_ST_LEN 0x2 /* start frame lenght in bit */
  221. #define MII_MF_OP_LEN 0x2 /* op code lenght in bit */
  222. #define MII_MF_ADDR_LEN 0x5 /* PHY addr lenght in bit */
  223. #define MII_MF_REG_LEN 0x5 /* PHY reg lenght in bit */
  224. #define MII_MF_TA_LEN 0x2 /* turnaround lenght in bit */
  225. #define MII_MF_DATA_LEN 0x10 /* data lenght in bit */
  227. /* defines related to the PHY device */
  228.  
  229. #define MII_PHY_PRE_INIT     0x0001          /* PHY info pre-initialized */
  230. #define MII_PHY_AUTO         0x0010          /* auto-negotiation allowed */
  231. #define MII_PHY_TBL          0x0020          /* use negotiation table */
  232. #define MII_PHY_100          0x0040          /* PHY may use 100Mbit speed */
  233. #define MII_PHY_10           0x0080          /* PHY may use 10Mbit speed */
  234. #define MII_PHY_FD           0x0100          /* PHY may use full duplex */
  235. #define MII_PHY_HD           0x0200          /* PHY may use half duplex */
  236. #define MII_PHY_ISO 0x0400          /* isolate all PHYs */
  237. #define MII_PHY_PWR_DOWN     0x0800          /* power down mode */
  238. #define MII_PHY_DEF_SET 0x1000 /* set a default mode */
  239. #define MII_ALL_BUS_SCAN 0x2000 /* scan the all bus */
  240. #define MII_PHY_MONITOR 0x4000 /* monitor the PHY's status */
  241. #define MII_PHY_INIT 0x8000 /* PHY info initialized */
  242. #define MII_PHY_1000T_FD 0x10000 /* PHY may use 1000-T full duplex */
  243. #define MII_PHY_1000T_HD 0x20000 /* PHY mau use 1000-T half duplex */
  244. #define MII_PHY_TX_FLOW_CTRL 0x40000 /* Transmit flow control */
  245. #define MII_PHY_RX_FLOW_CTRL 0x80000 /* Receive flow control */
  246. #define MII_PHY_GMII_TYPE 0x100000    /* GMII = 1, MII = 0 */
  248. /* miscellaneous defines */
  250. #define MII_PHY_DEF_DELAY   300             /* max delay before link up, etc. */
  251. #define MII_PHY_NO_DELAY    0x0     /* do not delay */
  252. #define MII_PHY_NULL        0xff            /* PHY is not present */
  253. #define MII_PHY_DEF_ADDR    0x0             /* default PHY's logical address */
  255. #ifndef MII_MONITOR_DELAY
  256. #   define MII_MONITOR_DELAY   0x5 /* in seconds */
  257. #endif
  259. #define MII_PHY_LINK_UNKNOWN 0x0       /* link method - Unknown */
  260. #define MII_PHY_LINK_AUTO 0x1       /* link method - Auto-Negotiation */
  261. #define MII_PHY_LINK_FORCE 0x2       /* link method - Force link */
  263. /*
  264.  * these values may be used in the default phy mode field of the load
  265.  * string, since that is used to force the operating mode of the PHY
  266.  * in case any attempt to establish the link failed.
  267.  */
  268.  
  269. #define PHY_10BASE_T            0x00     /* 10 Base-T */
  270. #define PHY_10BASE_T_FDX        0x01     /* 10 Base Tx, full duplex */
  271. #define PHY_100BASE_TX          0x02     /* 100 Base Tx */
  272. #define PHY_100BASE_TX_FDX      0x03     /* 100 Base TX, full duplex */
  273. #define PHY_100BASE_T4          0x04     /* 100 Base T4 */
  274. #define PHY_AN_ENABLE           0x05     /* re-enable auto-negotiation */
  275.  
  276. #define MII_FDX_STR         "full duplex"   /* full duplex mode */
  277. #define MII_FDX_LEN         sizeof (MII_FDX_STR)   /* full duplex mode */
  278. #define MII_HDX_STR         "half duplex"   /* half duplex mode */
  279. #define MII_HDX_LEN         sizeof (MII_HDX_STR)   /* full duplex mode */
  281. #define MII_AN_TBL_MAX 20 /* max number of entries in the table */
  283. /* allowed PHY's speeds */
  284. #define MII_1000MBS         1000000000      /* bits per sec */ 
  285. #define MII_100MBS          100000000       /* bits per sec */
  286. #define MII_10MBS           10000000        /* bits per sec */
  288. /* typedefs */
  290. typedef INT16 MII_AN_ORDER_TBL [MII_AN_TBL_MAX];
  292. typedef BOOL MII_PHY_BUS [MII_MAX_PHY_NUM];
  294. typedef struct mii_phy_node
  295.     {
  296.     NODE               node;
  297.     struct phy_info * pPhyInfo;
  298.     } MII_PHY_NODE;
  300. /* 
  301.  * the structure below only represents the status of the PHY's registers
  302.  * when they were last read through the MII interface
  303.  */
  305. typedef struct mii_regs
  306.     {
  307.     UINT16 phyStatus; /* PHY's status register */
  308.     UINT16 phyCtrl; /* PHY's control register */
  309.     UINT16 phyId1; /* PHY's identifier field 1 */
  310.     UINT16 phyId2; /* PHY's identifier field 2 */
  311.     UINT16 phyAds; /* PHY's advertisement register */
  312.     UINT16 phyPrtn; /* PHY's partner register */
  313.     UINT16 phyExp; /* PHY's expansion register */
  314.     UINT16 phyNext; /* PHY's next page transmit register */
  315.     } MII_REGS;
  317. typedef struct mii_g_regs
  318.     {
  319.     UINT16              phyRcvNext;     /* PHY'S partner received next page */
  320.     UINT16              phyMSCtrl;      /* PHY'S MASTER-SLAVE Control register */
  321.     UINT16              phyMSStatus;    /* PHY'S MASTER-SLAVE Status register */
  322.     UINT16              phyExtStatus;   /* PHY'S extented Status register */
  323.     } MII_G_REGS;
  326. /* 
  327.  * the structure below is to be allocated and filled in by the 
  328.  * driver before it attempts to use the miiPhyInit () routine. Some
  329.  * of its field may be overwritten by miiPhyInit (), since their initial
  330.  * values may not be appropriate. In addition, some field do not have
  331.  * to be initialized by the calling task, since miiPhyInit () may use a
  332.  * default value, whereas some other are mandatory. To help understand this,
  333.  * the comment for each field includes flags stating whether the relevent
  334.  * field in the PHY_INFO structure is an input (I) parameter to miiPhyInit (),
  335.  * an output (O) parameter, or an input-output (I/O) parameter first,
  336.  * and then whether it is optional (O) or mandatory (M). For output 
  337.  * parameters, the second flag is a "don't care" (X).
  338.  */
  340. typedef struct phy_info
  341.     {
  342.     MII_REGS         miiRegs; /* PHY registers - (O|X) */
  343.     UINT8 phyAddr; /* address of a PHY - (I/O)|(O) */
  344.     UINT32 phyFlags; /* some flags - (I/O)|(O) */
  345.     UINT32              phySpeed;    /* 10/100 Mbit/sec  - (O|X) */
  346.     char                phyMode[20];    /* half/full duplex mode  - (O|X) */
  347.     UINT32              phyDefMode;     /* default operating mode  - (I|O) */
  348.     MII_AN_ORDER_TBL * phyAnOrderTbl; /* auto-negotiation table - (I|O) */
  349.     FUNCPTR phyReadRtn; /* phy read routine - (I|M) */
  350.     FUNCPTR phyWriteRtn; /* phy write routine - (I|M) */
  351.     FUNCPTR phyDelayRtn; /* phy delay routine - (I|O) */
  352.     UINT32 phyDelayParm; /* parameter to delay routine - (I|O) */
  353.     UINT32 phyMaxDelay; /* phy max delay - (I|O) */
  354.     void *  pDrvCtrl; /* driver control structure - (I|M) */
  355.     FUNCPTR phyLinkDownRtn; /* phy status down routine - (I|O) */
  356.     MII_PHY_NODE * pMiiPhyNode; /* phy node - O */
  357.     MII_PHY_BUS * miiPhyPresent; /* which PHYs are there - O */
  358.     UINT32 phyLinkMethod; /* phy link method (Auto/Force) - (O|X) */
  359.     UINT32 phyAutoNegotiateFlags; /* flag for auto-negotiation - (O|X) */
  360.     MII_G_REGS miiGRegs;       /* Giga Bit PHY registers - (O|X) */
  361.     FUNCPTR pPhyOptRegsRtn; /* device specific pPhyOptRegsRtn */
  362.     } PHY_INFO;
  364. /* globals */
  365.  
  366. void   miiPhyOptFuncSet (FUNCPTR optRegsFunc);
  367. STATUS          miiPhyInit (PHY_INFO * pPhyInfo);
  368. STATUS          miiLibUnInit (void);
  369. STATUS          miiLibInit (void);
  370. STATUS          miiPhyUnInit (PHY_INFO * pPhyInfo);
  371. void            miiShow (PHY_INFO * pPhyInfo);
  372. STATUS          miiRegsGet (PHY_INFO * pPhyInfo, UINT regNum, UCHAR * buff);
  373. STATUS miiAnCheck (PHY_INFO * pPhyInfo, UINT8 phyAddr);
  375. #ifdef __cplusplus
  376. }
  377. #endif
  379. #endif /* __INCmiiLibh */