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 * Copied Form Linux 2.4.25 an unneeded items removed by:
8 * Timothy Legge (timlegge at etherboot dot org)
9 *
10 * 03/26/2004
11 */
12
13FILE_LICENCE ( GPL2_ONLY );
14
15#ifndef _MII_H_
16#define _MII_H_
17
18/* Generic MII registers. */
19
20#define MII_BMCR            0x00	/* Basic mode control register */
21#define MII_BMSR            0x01	/* Basic mode status register  */
22#define MII_PHYSID1         0x02        /* PHYS ID 1                   */
23#define MII_PHYSID2         0x03        /* PHYS ID 2                   */
24#define MII_ADVERTISE       0x04	/* Advertisement control reg   */
25#define MII_LPA             0x05	/* Link partner ability reg    */
26#define MII_EXPANSION       0x06        /* Expansion register          */
27#define MII_CTRL1000        0x09        /* 1000BASE-T control          */
28#define MII_STAT1000        0x0a        /* 1000BASE-T status           */
29#define MII_ESTATUS         0x0f        /* Extended Status */
30#define MII_DCOUNTER        0x12        /* Disconnect counter          */
31#define MII_FCSCOUNTER      0x13        /* False carrier counter       */
32#define MII_NWAYTEST        0x14        /* N-way auto-neg test reg     */
33#define MII_RERRCOUNTER     0x15        /* Receive error counter       */
34#define MII_SREVISION       0x16        /* Silicon revision            */
35#define MII_RESV1           0x17        /* Reserved...                 */
36#define MII_LBRERROR        0x18        /* Lpback, rx, bypass error    */
37#define MII_PHYADDR         0x19        /* PHY address                 */
38#define MII_RESV2           0x1a        /* Reserved...                 */
39#define MII_TPISTATUS       0x1b        /* TPI status for 10mbps       */
40#define MII_NCONFIG         0x1c        /* Network interface config    */
41
42/* Basic mode control register. */
43#define BMCR_RESV               0x003f  /* Unused...                   */
44#define BMCR_SPEED1000          0x0040  /* MSB of Speed (1000)         */
45#define BMCR_CTST               0x0080  /* Collision test              */
46#define BMCR_FULLDPLX           0x0100	/* Full duplex                 */
47#define BMCR_ANRESTART          0x0200	/* Auto negotiation restart    */
48#define BMCR_ISOLATE            0x0400  /* Disconnect DP83840 from MII */
49#define BMCR_PDOWN              0x0800  /* Powerdown the DP83840       */
50#define BMCR_ANENABLE           0x1000	/* Enable auto negotiation     */
51#define BMCR_SPEED100           0x2000	/* Select 100Mbps              */
52#define BMCR_LOOPBACK           0x4000  /* TXD loopback bits           */
53#define BMCR_RESET              0x8000	/* Reset the DP83840           */
54
55/* Basic mode status register. */
56#define BMSR_ERCAP              0x0001  /* Ext-reg capability          */
57#define BMSR_JCD                0x0002  /* Jabber detected             */
58#define BMSR_LSTATUS            0x0004  /* Link status                 */
59#define BMSR_ANEGCAPABLE        0x0008  /* Able to do auto-negotiation */
60#define BMSR_RFAULT             0x0010  /* Remote fault detected       */
61#define BMSR_ANEGCOMPLETE       0x0020  /* Auto-negotiation complete   */
62#define BMSR_RESV               0x00c0  /* Unused...                   */
63#define BMSR_ESTATEN            0x0100  /* Extended Status in R15 */
64#define BMSR_100HALF2           0x0200  /* Can do 100BASE-T2 HDX */
65#define BMSR_100FULL2           0x0400  /* Can do 100BASE-T2 FDX */
66#define BMSR_10HALF             0x0800  /* Can do 10mbps, half-duplex  */
67#define BMSR_10FULL             0x1000  /* Can do 10mbps, full-duplex  */
68#define BMSR_100HALF            0x2000  /* Can do 100mbps, half-duplex */
69#define BMSR_100FULL            0x4000  /* Can do 100mbps, full-duplex */
70#define BMSR_100BASE4           0x8000  /* Can do 100mbps, 4k packets  */
71
72/* Advertisement control register. */
73#define ADVERTISE_SLCT          0x001f  /* Selector bits               */
74#define ADVERTISE_CSMA          0x0001  /* Only selector supported     */
75#define ADVERTISE_10HALF        0x0020	/* Try for 10mbps half-duplex  */
76#define ADVERTISE_1000XFULL     0x0020  /* Try for 1000BASE-X full-duplex */
77#define ADVERTISE_10FULL        0x0040	/* Try for 10mbps full-duplex  */
78#define ADVERTISE_1000XHALF     0x0040  /* Try for 1000BASE-X half-duplex */
79#define ADVERTISE_100HALF       0x0080	/* Try for 100mbps half-duplex */
80#define ADVERTISE_1000XPAUSE    0x0080  /* Try for 1000BASE-X pause    */
81#define ADVERTISE_100FULL       0x0100	/* Try for 100mbps full-duplex */
82#define ADVERTISE_1000XPSE_ASYM 0x0100  /* Try for 1000BASE-X asym pause */
83#define ADVERTISE_100BASE4      0x0200  /* Try for 100mbps 4k packets  */
84#define ADVERTISE_PAUSE_CAP     0x0400  /* Try for pause               */
85#define ADVERTISE_PAUSE_ASYM    0x0800  /* Try for asymetric pause     */
86#define ADVERTISE_RESV          0x1000  /* Unused...                   */
87#define ADVERTISE_RFAULT        0x2000  /* Say we can detect faults    */
88#define ADVERTISE_LPACK         0x4000  /* Ack link partners response  */
89#define ADVERTISE_NPAGE         0x8000  /* Next page bit               */
90
91#define ADVERTISE_FULL (ADVERTISE_100FULL | ADVERTISE_10FULL | \
92			ADVERTISE_CSMA)
93#define ADVERTISE_ALL (ADVERTISE_10HALF | ADVERTISE_10FULL | \
94                      ADVERTISE_100HALF | ADVERTISE_100FULL)
95
96/* Link partner ability register. */
97#define LPA_SLCT                0x001f  /* Same as advertise selector  */
98#define LPA_10HALF              0x0020  /* Can do 10mbps half-duplex   */
99#define LPA_1000XFULL           0x0020  /* Can do 1000BASE-X full-duplex */
100#define LPA_10FULL              0x0040  /* Can do 10mbps full-duplex   */
101#define LPA_1000XHALF           0x0040  /* Can do 1000BASE-X half-duplex */
102#define LPA_100HALF             0x0080  /* Can do 100mbps half-duplex  */
103#define LPA_1000XPAUSE          0x0080  /* Can do 1000BASE-X pause     */
104#define LPA_100FULL             0x0100  /* Can do 100mbps full-duplex  */
105#define LPA_1000XPAUSE_ASYM     0x0100  /* Can do 1000BASE-X pause asym*/
106#define LPA_100BASE4            0x0200  /* Can do 100mbps 4k packets   */
107#define LPA_PAUSE_CAP           0x0400  /* Can pause                   */
108#define LPA_PAUSE_ASYM          0x0800  /* Can pause asymetrically     */
109#define LPA_RESV                0x1000  /* Unused...                   */
110#define LPA_RFAULT              0x2000  /* Link partner faulted        */
111#define LPA_LPACK               0x4000  /* Link partner acked us       */
112#define LPA_NPAGE               0x8000  /* Next page bit               */
113
114#define LPA_DUPLEX            (LPA_10FULL | LPA_100FULL)
115#define LPA_100                       (LPA_100FULL | LPA_100HALF | LPA_100BASE4)
116
117/* Expansion register for auto-negotiation. */
118#define EXPANSION_NWAY          0x0001  /* Can do N-way auto-nego      */
119#define EXPANSION_LCWP          0x0002  /* Got new RX page code word   */
120#define EXPANSION_ENABLENPAGE   0x0004  /* This enables npage words    */
121#define EXPANSION_NPCAPABLE     0x0008  /* Link partner supports npage */
122#define EXPANSION_MFAULTS       0x0010  /* Multiple faults detected    */
123#define EXPANSION_RESV          0xffe0  /* Unused...                   */
124
125#define ESTATUS_1000_TFULL      0x2000  /* Can do 1000BT Full */
126#define ESTATUS_1000_THALF      0x1000  /* Can do 1000BT Half */
127
128/* N-way test register. */
129#define NWAYTEST_RESV1          0x00ff  /* Unused...                   */
130#define NWAYTEST_LOOPBACK       0x0100  /* Enable loopback for N-way   */
131#define NWAYTEST_RESV2          0xfe00  /* Unused...                   */
132
133/* 1000BASE-T Control register */
134#define ADVERTISE_1000FULL      0x0200  /* Advertise 1000BASE-T full duplex */
135#define ADVERTISE_1000HALF      0x0100  /* Advertise 1000BASE-T half duplex */
136
137/* 1000BASE-T Status register */
138#define LPA_1000LOCALRXOK       0x2000  /* Link partner local receiver status */
139#define LPA_1000REMRXOK         0x1000  /* Link partner remote receiver status */
140#define LPA_1000FULL            0x0800  /* Link partner 1000BASE-T full duplex */
141#define LPA_1000HALF            0x0400  /* Link partner 1000BASE-T half duplex */
142
143#include <gpxe/netdevice.h>
144
145struct mii_if_info {
146        int phy_id;
147        int advertising;
148        int phy_id_mask;
149        int reg_num_mask;
150
151        unsigned int full_duplex : 1;   /* is full duplex? */
152        unsigned int force_media : 1;   /* is autoneg. disabled? */
153        unsigned int supports_gmii : 1; /* are GMII registers supported? */
154
155        struct net_device *dev;
156        int (*mdio_read) (struct net_device *dev, int phy_id, int location);
157        void (*mdio_write) (struct net_device *dev, int phy_id, int location, int val);
158};
159
160
161extern int mii_link_ok (struct mii_if_info *mii);
162extern void mii_check_link (struct mii_if_info *mii);
163extern unsigned int mii_check_media (struct mii_if_info *mii,
164                                       unsigned int ok_to_print,
165                                       unsigned int init_media);
166
167
168/**
169 * mii_nway_result
170 * @negotiated: value of MII ANAR and'd with ANLPAR
171 *
172 * Given a set of MII abilities, check each bit and returns the
173 * currently supported media, in the priority order defined by
174 * IEEE 802.3u.  We use LPA_xxx constants but note this is not the
175 * value of LPA solely, as described above.
176 *
177 * The one exception to IEEE 802.3u is that 100baseT4 is placed
178 * between 100T-full and 100T-half.  If your phy does not support
179 * 100T4 this is fine.  If your phy places 100T4 elsewhere in the
180 * priority order, you will need to roll your own function.
181 */
182static inline unsigned int mii_nway_result (unsigned int negotiated)
183{
184        unsigned int ret;
185
186        if (negotiated & LPA_100FULL)
187                ret = LPA_100FULL;
188        else if (negotiated & LPA_100BASE4)
189                ret = LPA_100BASE4;
190        else if (negotiated & LPA_100HALF)
191                ret = LPA_100HALF;
192        else if (negotiated & LPA_10FULL)
193                ret = LPA_10FULL;
194        else
195                ret = LPA_10HALF;
196
197        return ret;
198}
199
200/**
201 * mii_duplex
202 * @duplex_lock: Non-zero if duplex is locked at full
203 * @negotiated: value of MII ANAR and'd with ANLPAR
204 *
205 * A small helper function for a common case.  Returns one
206 * if the media is operating or locked at full duplex, and
207 * returns zero otherwise.
208 */
209static inline unsigned int mii_duplex (unsigned int duplex_lock,
210                                       unsigned int negotiated)
211{
212        if (duplex_lock)
213                return 1;
214        if (mii_nway_result(negotiated) & LPA_DUPLEX)
215                return 1;
216        return 0;
217}
218
219#endif
220