ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / include / linux / mii.h
1 /*
2  * linux/mii.h: definitions for MII-compatible transceivers
3  * Originally drivers/net/sunhme.h.
4  *
5  * Copyright (C) 1996, 1999, 2001 David S. Miller (davem@redhat.com)
6  */
7
8 #ifndef __LINUX_MII_H__
9 #define __LINUX_MII_H__
10
11 #include <linux/types.h>
12
13 /* Generic MII registers. */
14
15 #define MII_BMCR            0x00        /* Basic mode control register */
16 #define MII_BMSR            0x01        /* Basic mode status register  */
17 #define MII_PHYSID1         0x02        /* PHYS ID 1                   */
18 #define MII_PHYSID2         0x03        /* PHYS ID 2                   */
19 #define MII_ADVERTISE       0x04        /* Advertisement control reg   */
20 #define MII_LPA             0x05        /* Link partner ability reg    */
21 #define MII_EXPANSION       0x06        /* Expansion register          */
22 #define MII_DCOUNTER        0x12        /* Disconnect counter          */
23 #define MII_FCSCOUNTER      0x13        /* False carrier counter       */
24 #define MII_NWAYTEST        0x14        /* N-way auto-neg test reg     */
25 #define MII_RERRCOUNTER     0x15        /* Receive error counter       */
26 #define MII_SREVISION       0x16        /* Silicon revision            */
27 #define MII_RESV1           0x17        /* Reserved...                 */
28 #define MII_LBRERROR        0x18        /* Lpback, rx, bypass error    */
29 #define MII_PHYADDR         0x19        /* PHY address                 */
30 #define MII_RESV2           0x1a        /* Reserved...                 */
31 #define MII_TPISTATUS       0x1b        /* TPI status for 10mbps       */
32 #define MII_NCONFIG         0x1c        /* Network interface config    */
33
34 /* Basic mode control register. */
35 #define BMCR_RESV               0x007f  /* Unused...                   */
36 #define BMCR_CTST               0x0080  /* Collision test              */
37 #define BMCR_FULLDPLX           0x0100  /* Full duplex                 */
38 #define BMCR_ANRESTART          0x0200  /* Auto negotiation restart    */
39 #define BMCR_ISOLATE            0x0400  /* Disconnect DP83840 from MII */
40 #define BMCR_PDOWN              0x0800  /* Powerdown the DP83840       */
41 #define BMCR_ANENABLE           0x1000  /* Enable auto negotiation     */
42 #define BMCR_SPEED100           0x2000  /* Select 100Mbps              */
43 #define BMCR_LOOPBACK           0x4000  /* TXD loopback bits           */
44 #define BMCR_RESET              0x8000  /* Reset the DP83840           */
45
46 /* Basic mode status register. */
47 #define BMSR_ERCAP              0x0001  /* Ext-reg capability          */
48 #define BMSR_JCD                0x0002  /* Jabber detected             */
49 #define BMSR_LSTATUS            0x0004  /* Link status                 */
50 #define BMSR_ANEGCAPABLE        0x0008  /* Able to do auto-negotiation */
51 #define BMSR_RFAULT             0x0010  /* Remote fault detected       */
52 #define BMSR_ANEGCOMPLETE       0x0020  /* Auto-negotiation complete   */
53 #define BMSR_RESV               0x07c0  /* Unused...                   */
54 #define BMSR_10HALF             0x0800  /* Can do 10mbps, half-duplex  */
55 #define BMSR_10FULL             0x1000  /* Can do 10mbps, full-duplex  */
56 #define BMSR_100HALF            0x2000  /* Can do 100mbps, half-duplex */
57 #define BMSR_100FULL            0x4000  /* Can do 100mbps, full-duplex */
58 #define BMSR_100BASE4           0x8000  /* Can do 100mbps, 4k packets  */
59
60 /* Advertisement control register. */
61 #define ADVERTISE_SLCT          0x001f  /* Selector bits               */
62 #define ADVERTISE_CSMA          0x0001  /* Only selector supported     */
63 #define ADVERTISE_10HALF        0x0020  /* Try for 10mbps half-duplex  */
64 #define ADVERTISE_10FULL        0x0040  /* Try for 10mbps full-duplex  */
65 #define ADVERTISE_100HALF       0x0080  /* Try for 100mbps half-duplex */
66 #define ADVERTISE_100FULL       0x0100  /* Try for 100mbps full-duplex */
67 #define ADVERTISE_100BASE4      0x0200  /* Try for 100mbps 4k packets  */
68 #define ADVERTISE_RESV          0x1c00  /* Unused...                   */
69 #define ADVERTISE_RFAULT        0x2000  /* Say we can detect faults    */
70 #define ADVERTISE_LPACK         0x4000  /* Ack link partners response  */
71 #define ADVERTISE_NPAGE         0x8000  /* Next page bit               */
72
73 #define ADVERTISE_FULL (ADVERTISE_100FULL | ADVERTISE_10FULL | \
74                         ADVERTISE_CSMA)
75 #define ADVERTISE_ALL (ADVERTISE_10HALF | ADVERTISE_10FULL | \
76                        ADVERTISE_100HALF | ADVERTISE_100FULL)
77
78 /* Link partner ability register. */
79 #define LPA_SLCT                0x001f  /* Same as advertise selector  */
80 #define LPA_10HALF              0x0020  /* Can do 10mbps half-duplex   */
81 #define LPA_10FULL              0x0040  /* Can do 10mbps full-duplex   */
82 #define LPA_100HALF             0x0080  /* Can do 100mbps half-duplex  */
83 #define LPA_100FULL             0x0100  /* Can do 100mbps full-duplex  */
84 #define LPA_100BASE4            0x0200  /* Can do 100mbps 4k packets   */
85 #define LPA_RESV                0x1c00  /* Unused...                   */
86 #define LPA_RFAULT              0x2000  /* Link partner faulted        */
87 #define LPA_LPACK               0x4000  /* Link partner acked us       */
88 #define LPA_NPAGE               0x8000  /* Next page bit               */
89
90 #define LPA_DUPLEX              (LPA_10FULL | LPA_100FULL)
91 #define LPA_100                 (LPA_100FULL | LPA_100HALF | LPA_100BASE4)
92
93 /* Expansion register for auto-negotiation. */
94 #define EXPANSION_NWAY          0x0001  /* Can do N-way auto-nego      */
95 #define EXPANSION_LCWP          0x0002  /* Got new RX page code word   */
96 #define EXPANSION_ENABLENPAGE   0x0004  /* This enables npage words    */
97 #define EXPANSION_NPCAPABLE     0x0008  /* Link partner supports npage */
98 #define EXPANSION_MFAULTS       0x0010  /* Multiple faults detected    */
99 #define EXPANSION_RESV          0xffe0  /* Unused...                   */
100
101 /* N-way test register. */
102 #define NWAYTEST_RESV1          0x00ff  /* Unused...                   */
103 #define NWAYTEST_LOOPBACK       0x0100  /* Enable loopback for N-way   */
104 #define NWAYTEST_RESV2          0xfe00  /* Unused...                   */
105
106
107 struct mii_if_info {
108         int phy_id;
109         int advertising;
110         int phy_id_mask;
111         int reg_num_mask;
112
113         unsigned int full_duplex : 1;   /* is full duplex? */
114         unsigned int force_media : 1;   /* is autoneg. disabled? */
115
116         struct net_device *dev;
117         int (*mdio_read) (struct net_device *dev, int phy_id, int location);
118         void (*mdio_write) (struct net_device *dev, int phy_id, int location, int val);
119 };
120
121 struct ethtool_cmd;
122 struct mii_ioctl_data;
123
124 extern int mii_link_ok (struct mii_if_info *mii);
125 extern int mii_nway_restart (struct mii_if_info *mii);
126 extern int mii_ethtool_gset(struct mii_if_info *mii, struct ethtool_cmd *ecmd);
127 extern int mii_ethtool_sset(struct mii_if_info *mii, struct ethtool_cmd *ecmd);
128 extern void mii_check_link (struct mii_if_info *mii);
129 extern unsigned int mii_check_media (struct mii_if_info *mii,
130                                      unsigned int ok_to_print,
131                                      unsigned int init_media);
132 extern int generic_mii_ioctl(struct mii_if_info *mii_if,
133                              struct mii_ioctl_data *mii_data, int cmd,
134                              unsigned int *duplex_changed);
135
136
137
138 /* This structure is used in all SIOCxMIIxxx ioctl calls */
139 struct mii_ioctl_data {
140         u16             phy_id;
141         u16             reg_num;
142         u16             val_in;
143         u16             val_out;
144 };
145
146
147 /**
148  * mii_nway_result
149  * @negotiated: value of MII ANAR and'd with ANLPAR
150  *
151  * Given a set of MII abilities, check each bit and returns the
152  * currently supported media, in the priority order defined by
153  * IEEE 802.3u.  We use LPA_xxx constants but note this is not the
154  * value of LPA solely, as described above.
155  *
156  * The one exception to IEEE 802.3u is that 100baseT4 is placed
157  * between 100T-full and 100T-half.  If your phy does not support
158  * 100T4 this is fine.  If your phy places 100T4 elsewhere in the
159  * priority order, you will need to roll your own function.
160  */
161 static inline unsigned int mii_nway_result (unsigned int negotiated)
162 {
163         unsigned int ret;
164
165         if (negotiated & LPA_100FULL)
166                 ret = LPA_100FULL;
167         else if (negotiated & LPA_100BASE4)
168                 ret = LPA_100BASE4;
169         else if (negotiated & LPA_100HALF)
170                 ret = LPA_100HALF;
171         else if (negotiated & LPA_10FULL)
172                 ret = LPA_10FULL;
173         else
174                 ret = LPA_10HALF;
175
176         return ret;
177 }
178
179 /**
180  * mii_duplex
181  * @duplex_lock: Non-zero if duplex is locked at full
182  * @negotiated: value of MII ANAR and'd with ANLPAR
183  *
184  * A small helper function for a common case.  Returns one
185  * if the media is operating or locked at full duplex, and
186  * returns zero otherwise.
187  */
188 static inline unsigned int mii_duplex (unsigned int duplex_lock,
189                                        unsigned int negotiated)
190 {
191         if (duplex_lock)
192                 return 1;
193         if (mii_nway_result(negotiated) & LPA_DUPLEX)
194                 return 1;
195         return 0;
196 }
197
198
199 #endif /* __LINUX_MII_H__ */