mii.h 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230
  1. /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
  2. /*
  3. * linux/mii.h: definitions for MII-compatible transceivers
  4. * Originally drivers/net/sunhme.h.
  5. *
  6. * Copyright (C) 1996, 1999, 2001 David S. Miller (davem@redhat.com)
  7. */
  8. #ifndef __LINUX_MII_H__
  9. #define __LINUX_MII_H__
  10. /* Generic MII registers. */
  11. #define MII_BMCR 0x00 /* Basic mode control register */
  12. #define MII_BMSR 0x01 /* Basic mode status register */
  13. #define MII_PHYSID1 0x02 /* PHYS ID 1 */
  14. #define MII_PHYSID2 0x03 /* PHYS ID 2 */
  15. #define MII_ADVERTISE 0x04 /* Advertisement control reg */
  16. #define MII_LPA 0x05 /* Link partner ability reg */
  17. #define MII_EXPANSION 0x06 /* Expansion register */
  18. #define MII_CTRL1000 0x09 /* 1000BASE-T control */
  19. #define MII_STAT1000 0x0a /* 1000BASE-T status */
  20. #define MII_MMD_CTRL 0x0d /* MMD Access Control Register */
  21. #define MII_MMD_DATA 0x0e /* MMD Access Data Register */
  22. #define MII_ESTATUS 0x0f /* Extended Status */
  23. #define MII_DCOUNTER 0x12 /* Disconnect counter */
  24. #define MII_FCSCOUNTER 0x13 /* False carrier counter */
  25. #define MII_NWAYTEST 0x14 /* N-way auto-neg test reg */
  26. #define MII_RERRCOUNTER 0x15 /* Receive error counter */
  27. #define MII_SREVISION 0x16 /* Silicon revision */
  28. #define MII_RESV1 0x17 /* Reserved... */
  29. #define MII_LBRERROR 0x18 /* Lpback, rx, bypass error */
  30. #define MII_PHYADDR 0x19 /* PHY address */
  31. #define MII_RESV2 0x1a /* Reserved... */
  32. #define MII_TPISTATUS 0x1b /* TPI status for 10mbps */
  33. #define MII_NCONFIG 0x1c /* Network interface config */
  34. /* Basic mode control register. */
  35. #define BMCR_RESV 0x003f /* Unused... */
  36. #define BMCR_SPEED1000 0x0040 /* MSB of Speed (1000) */
  37. #define BMCR_CTST 0x0080 /* Collision test */
  38. #define BMCR_FULLDPLX 0x0100 /* Full duplex */
  39. #define BMCR_ANRESTART 0x0200 /* Auto negotiation restart */
  40. #define BMCR_ISOLATE 0x0400 /* Isolate data paths from MII */
  41. #define BMCR_PDOWN 0x0800 /* Enable low power state */
  42. #define BMCR_ANENABLE 0x1000 /* Enable auto negotiation */
  43. #define BMCR_SPEED100 0x2000 /* Select 100Mbps */
  44. #define BMCR_LOOPBACK 0x4000 /* TXD loopback bits */
  45. #define BMCR_RESET 0x8000 /* Reset to default state */
  46. #define BMCR_SPEED10 0x0000 /* Select 10Mbps */
  47. /* Basic mode status register. */
  48. #define BMSR_ERCAP 0x0001 /* Ext-reg capability */
  49. #define BMSR_JCD 0x0002 /* Jabber detected */
  50. #define BMSR_LSTATUS 0x0004 /* Link status */
  51. #define BMSR_ANEGCAPABLE 0x0008 /* Able to do auto-negotiation */
  52. #define BMSR_RFAULT 0x0010 /* Remote fault detected */
  53. #define BMSR_ANEGCOMPLETE 0x0020 /* Auto-negotiation complete */
  54. #define BMSR_RESV 0x00c0 /* Unused... */
  55. #define BMSR_ESTATEN 0x0100 /* Extended Status in R15 */
  56. #define BMSR_100HALF2 0x0200 /* Can do 100BASE-T2 HDX */
  57. #define BMSR_100FULL2 0x0400 /* Can do 100BASE-T2 FDX */
  58. #define BMSR_10HALF 0x0800 /* Can do 10mbps, half-duplex */
  59. #define BMSR_10FULL 0x1000 /* Can do 10mbps, full-duplex */
  60. #define BMSR_100HALF 0x2000 /* Can do 100mbps, half-duplex */
  61. #define BMSR_100FULL 0x4000 /* Can do 100mbps, full-duplex */
  62. #define BMSR_100BASE4 0x8000 /* Can do 100mbps, 4k packets */
  63. /* Advertisement control register. */
  64. #define ADVERTISE_SLCT 0x001f /* Selector bits */
  65. #define ADVERTISE_CSMA 0x0001 /* Only selector supported */
  66. #define ADVERTISE_10HALF 0x0020 /* Try for 10mbps half-duplex */
  67. #define ADVERTISE_1000XFULL 0x0020 /* Try for 1000BASE-X full-duplex */
  68. #define ADVERTISE_10FULL 0x0040 /* Try for 10mbps full-duplex */
  69. #define ADVERTISE_1000XHALF 0x0040 /* Try for 1000BASE-X half-duplex */
  70. #define ADVERTISE_100HALF 0x0080 /* Try for 100mbps half-duplex */
  71. #define ADVERTISE_1000XPAUSE 0x0080 /* Try for 1000BASE-X pause */
  72. #define ADVERTISE_100FULL 0x0100 /* Try for 100mbps full-duplex */
  73. #define ADVERTISE_1000XPSE_ASYM 0x0100 /* Try for 1000BASE-X asym pause */
  74. #define ADVERTISE_100BASE4 0x0200 /* Try for 100mbps 4k packets */
  75. #define ADVERTISE_PAUSE_CAP 0x0400 /* Try for pause */
  76. #define ADVERTISE_PAUSE_ASYM 0x0800 /* Try for asymetric pause */
  77. #define ADVERTISE_RESV 0x1000 /* Unused... */
  78. #define ADVERTISE_RFAULT 0x2000 /* Say we can detect faults */
  79. #define ADVERTISE_LPACK 0x4000 /* Ack link partners response */
  80. #define ADVERTISE_NPAGE 0x8000 /* Next page bit */
  81. #define ADVERTISE_FULL (ADVERTISE_100FULL | ADVERTISE_10FULL | \
  82. ADVERTISE_CSMA)
  83. #define ADVERTISE_ALL (ADVERTISE_10HALF | ADVERTISE_10FULL | \
  84. ADVERTISE_100HALF | ADVERTISE_100FULL)
  85. /* Link partner ability register. */
  86. #define LPA_SLCT 0x001f /* Same as advertise selector */
  87. #define LPA_10HALF 0x0020 /* Can do 10mbps half-duplex */
  88. #define LPA_1000XFULL 0x0020 /* Can do 1000BASE-X full-duplex */
  89. #define LPA_10FULL 0x0040 /* Can do 10mbps full-duplex */
  90. #define LPA_1000XHALF 0x0040 /* Can do 1000BASE-X half-duplex */
  91. #define LPA_100HALF 0x0080 /* Can do 100mbps half-duplex */
  92. #define LPA_1000XPAUSE 0x0080 /* Can do 1000BASE-X pause */
  93. #define LPA_100FULL 0x0100 /* Can do 100mbps full-duplex */
  94. #define LPA_1000XPAUSE_ASYM 0x0100 /* Can do 1000BASE-X pause asym*/
  95. #define LPA_100BASE4 0x0200 /* Can do 100mbps 4k packets */
  96. #define LPA_PAUSE_CAP 0x0400 /* Can pause */
  97. #define LPA_PAUSE_ASYM 0x0800 /* Can pause asymetrically */
  98. #define LPA_RESV 0x1000 /* Unused... */
  99. #define LPA_RFAULT 0x2000 /* Link partner faulted */
  100. #define LPA_LPACK 0x4000 /* Link partner acked us */
  101. #define LPA_NPAGE 0x8000 /* Next page bit */
  102. #define LPA_DUPLEX (LPA_10FULL | LPA_100FULL)
  103. #define LPA_100 (LPA_100FULL | LPA_100HALF | LPA_100BASE4)
  104. /* Expansion register for auto-negotiation. */
  105. #define EXPANSION_NWAY 0x0001 /* Can do N-way auto-nego */
  106. #define EXPANSION_LCWP 0x0002 /* Got new RX page code word */
  107. #define EXPANSION_ENABLENPAGE 0x0004 /* This enables npage words */
  108. #define EXPANSION_NPCAPABLE 0x0008 /* Link partner supports npage */
  109. #define EXPANSION_MFAULTS 0x0010 /* Multiple faults detected */
  110. #define EXPANSION_RESV 0xffe0 /* Unused... */
  111. #define ESTATUS_1000_XFULL 0x8000 /* Can do 1000BX Full */
  112. #define ESTATUS_1000_XHALF 0x4000 /* Can do 1000BX Half */
  113. #define ESTATUS_1000_TFULL 0x2000 /* Can do 1000BT Full */
  114. #define ESTATUS_1000_THALF 0x1000 /* Can do 1000BT Half */
  115. /* N-way test register. */
  116. #define NWAYTEST_RESV1 0x00ff /* Unused... */
  117. #define NWAYTEST_LOOPBACK 0x0100 /* Enable loopback for N-way */
  118. #define NWAYTEST_RESV2 0xfe00 /* Unused... */
  119. /* 1000BASE-T Control register */
  120. #define ADVERTISE_1000FULL 0x0200 /* Advertise 1000BASE-T full duplex */
  121. #define ADVERTISE_1000HALF 0x0100 /* Advertise 1000BASE-T half duplex */
  122. #define CTL1000_AS_MASTER 0x0800
  123. #define CTL1000_ENABLE_MASTER 0x1000
  124. /* 1000BASE-T Status register */
  125. #define LPA_1000LOCALRXOK 0x2000 /* Link partner local receiver status */
  126. #define LPA_1000REMRXOK 0x1000 /* Link partner remote receiver status */
  127. #define LPA_1000FULL 0x0800 /* Link partner 1000BASE-T full duplex */
  128. #define LPA_1000HALF 0x0400 /* Link partner 1000BASE-T half duplex */
  129. /* Flow control flags */
  130. #define FLOW_CTRL_TX 0x01
  131. #define FLOW_CTRL_RX 0x02
  132. /* MMD Access Control register fields */
  133. #define MII_MMD_CTRL_DEVAD_MASK 0x1f /* Mask MMD DEVAD*/
  134. #define MII_MMD_CTRL_ADDR 0x0000 /* Address */
  135. #define MII_MMD_CTRL_NOINCR 0x4000 /* no post increment */
  136. #define MII_MMD_CTRL_INCR_RDWT 0x8000 /* post increment on reads & writes */
  137. #define MII_MMD_CTRL_INCR_ON_WT 0xC000 /* post increment on writes only */
  138. /**
  139. * mii_nway_result
  140. * @negotiated: value of MII ANAR and'd with ANLPAR
  141. *
  142. * Given a set of MII abilities, check each bit and returns the
  143. * currently supported media, in the priority order defined by
  144. * IEEE 802.3u. We use LPA_xxx constants but note this is not the
  145. * value of LPA solely, as described above.
  146. *
  147. * The one exception to IEEE 802.3u is that 100baseT4 is placed
  148. * between 100T-full and 100T-half. If your phy does not support
  149. * 100T4 this is fine. If your phy places 100T4 elsewhere in the
  150. * priority order, you will need to roll your own function.
  151. */
  152. static inline unsigned int mii_nway_result (unsigned int negotiated)
  153. {
  154. unsigned int ret;
  155. if (negotiated & LPA_100FULL)
  156. ret = LPA_100FULL;
  157. else if (negotiated & LPA_100BASE4)
  158. ret = LPA_100BASE4;
  159. else if (negotiated & LPA_100HALF)
  160. ret = LPA_100HALF;
  161. else if (negotiated & LPA_10FULL)
  162. ret = LPA_10FULL;
  163. else
  164. ret = LPA_10HALF;
  165. return ret;
  166. }
  167. /**
  168. * mii_duplex
  169. * @duplex_lock: Non-zero if duplex is locked at full
  170. * @negotiated: value of MII ANAR and'd with ANLPAR
  171. *
  172. * A small helper function for a common case. Returns one
  173. * if the media is operating or locked at full duplex, and
  174. * returns zero otherwise.
  175. */
  176. static inline unsigned int mii_duplex (unsigned int duplex_lock,
  177. unsigned int negotiated)
  178. {
  179. if (duplex_lock)
  180. return 1;
  181. if (mii_nway_result(negotiated) & LPA_DUPLEX)
  182. return 1;
  183. return 0;
  184. }
  185. /**
  186. * mii_resolve_flowctrl_fdx
  187. * @lcladv: value of MII ADVERTISE register
  188. * @rmtadv: value of MII LPA register
  189. *
  190. * Resolve full duplex flow control as per IEEE 802.3-2005 table 28B-3
  191. */
  192. static inline u8 mii_resolve_flowctrl_fdx(u16 lcladv, u16 rmtadv)
  193. {
  194. u8 cap = 0;
  195. if (lcladv & rmtadv & ADVERTISE_PAUSE_CAP) {
  196. cap = FLOW_CTRL_TX | FLOW_CTRL_RX;
  197. } else if (lcladv & rmtadv & ADVERTISE_PAUSE_ASYM) {
  198. if (lcladv & ADVERTISE_PAUSE_CAP)
  199. cap = FLOW_CTRL_RX;
  200. else if (rmtadv & ADVERTISE_PAUSE_CAP)
  201. cap = FLOW_CTRL_TX;
  202. }
  203. return cap;
  204. }
  205. void mii_init(void);
  206. #endif /* __LINUX_MII_H__ */