xref: /freebsd/sys/dev/mii/nsgphy.c (revision 7899f917b1c0ea178f1d2be0cfb452086d079d23)
1 /*-
2  * SPDX-License-Identifier: BSD-4-Clause
3  *
4  * Copyright (c) 2001 Wind River Systems
5  * Copyright (c) 2001
6  *	Bill Paul <wpaul@bsdi.com>.  All rights reserved.
7  * Copyright (c) 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc.
8  * All rights reserved.
9  *
10  * This code is derived from software contributed to The NetBSD Foundation
11  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
12  * NASA Ames Research Center.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions
16  * are met:
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  * 2. Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the
21  *    documentation and/or other materials provided with the distribution.
22  * 3. All advertising materials mentioning features or use of this software
23  *    must display the following acknowledgement:
24  *	This product includes software developed by Bill Paul.
25  * 4. Neither the name of the author nor the names of any co-contributors
26  *    may be used to endorse or promote products derived from this software
27  *    without specific prior written permission.
28  *
29  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
30  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
33  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
34  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
35  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
36  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
37  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
39  * THE POSSIBILITY OF SUCH DAMAGE.
40  */
41 
42 #include <sys/cdefs.h>
43 /*
44  * Driver for the National Semiconductor DP83861, DP83865 and DP83891
45  * 10/100/1000 PHYs.
46  * Datasheet available at: http://www.national.com/ds/DP/DP83861.pdf
47  * and at: http://www.national.com/ds/DP/DP83865.pdf
48  *
49  * The DP83891 is the older NS GigE PHY which isn't being sold
50  * anymore.  The DP83861 is its replacement, which is an 'enhanced'
51  * firmware driven component.  The major difference between the
52  * two is that the DP83891 can't generate interrupts, while the
53  * 83861 can (probably it wasn't originally designed to do this, but
54  * it can now thanks to firmware updates).  The DP83861 also allows
55  * access to its internal RAM via indirect register access.  The
56  * DP83865 is an ultra low power version of the DP83861 and DP83891.
57  */
58 
59 #include <sys/param.h>
60 #include <sys/systm.h>
61 #include <sys/kernel.h>
62 #include <sys/module.h>
63 #include <sys/socket.h>
64 #include <sys/bus.h>
65 
66 #include <net/if.h>
67 #include <net/if_media.h>
68 
69 #include <dev/mii/mii.h>
70 #include <dev/mii/miivar.h>
71 #include "miidevs.h"
72 
73 #include <dev/mii/nsgphyreg.h>
74 
75 #include "miibus_if.h"
76 
77 static int nsgphy_probe(device_t);
78 static int nsgphy_attach(device_t);
79 
80 static device_method_t nsgphy_methods[] = {
81 	/* device interface */
82 	DEVMETHOD(device_probe,		nsgphy_probe),
83 	DEVMETHOD(device_attach,	nsgphy_attach),
84 	DEVMETHOD(device_detach,	mii_phy_detach),
85 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
86 	DEVMETHOD_END
87 };
88 
89 static driver_t nsgphy_driver = {
90 	"nsgphy",
91 	nsgphy_methods,
92 	sizeof(struct mii_softc)
93 };
94 
95 DRIVER_MODULE(nsgphy, miibus, nsgphy_driver, 0, 0);
96 
97 static int	nsgphy_service(struct mii_softc *, struct mii_data *,int);
98 static void	nsgphy_status(struct mii_softc *);
99 
100 static const struct mii_phydesc nsgphys[] = {
101 	MII_PHY_DESC(xxNATSEMI, DP83861),
102 	MII_PHY_DESC(xxNATSEMI, DP83865),
103 	MII_PHY_DESC(xxNATSEMI, DP83891),
104 	MII_PHY_END
105 };
106 
107 static const struct mii_phy_funcs nsgphy_funcs = {
108 	nsgphy_service,
109 	nsgphy_status,
110 	mii_phy_reset
111 };
112 
113 static int
114 nsgphy_probe(device_t dev)
115 {
116 
117 	return (mii_phy_dev_probe(dev, nsgphys, BUS_PROBE_DEFAULT));
118 }
119 
120 static int
121 nsgphy_attach(device_t dev)
122 {
123 	struct mii_softc *sc;
124 
125 	sc = device_get_softc(dev);
126 
127 	mii_phy_dev_attach(dev, MIIF_NOMANPAUSE, &nsgphy_funcs, 0);
128 
129 	PHY_RESET(sc);
130 
131 	/*
132 	 * NB: the PHY has the 10BASE-T BMSR bits hard-wired to 0,
133 	 * even though it supports 10BASE-T.
134 	 */
135 	sc->mii_capabilities = (PHY_READ(sc, MII_BMSR) |
136 	    BMSR_10TFDX | BMSR_10THDX) & sc->mii_capmask;
137 	/*
138 	 * Note that as documented manual 1000BASE-T modes of DP83865 only
139 	 * work together with other National Semiconductor PHYs.
140 	 */
141 	if (sc->mii_capabilities & BMSR_EXTSTAT)
142 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
143 
144 	mii_phy_add_media(sc);
145 	printf("\n");
146 
147 	MIIBUS_MEDIAINIT(sc->mii_dev);
148 	return (0);
149 }
150 
151 static int
152 nsgphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
153 {
154 
155 	switch (cmd) {
156 	case MII_POLLSTAT:
157 		break;
158 
159 	case MII_MEDIACHG:
160 		mii_phy_setmedia(sc);
161 		break;
162 
163 	case MII_TICK:
164 		if (mii_phy_tick(sc) == EJUSTRETURN)
165 			return (0);
166 		break;
167 	}
168 
169 	/* Update the media status. */
170 	PHY_STATUS(sc);
171 
172 	/* Callback if something changed. */
173 	mii_phy_update(sc, cmd);
174 	return (0);
175 }
176 
177 static void
178 nsgphy_status(struct mii_softc *sc)
179 {
180 	struct mii_data *mii = sc->mii_pdata;
181 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
182 	int bmsr, bmcr, physup, gtsr;
183 
184 	mii->mii_media_status = IFM_AVALID;
185 	mii->mii_media_active = IFM_ETHER;
186 
187 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
188 
189 	physup = PHY_READ(sc, NSGPHY_MII_PHYSUP);
190 
191 	if (physup & PHY_SUP_LINK)
192 		mii->mii_media_status |= IFM_ACTIVE;
193 
194 	bmcr = PHY_READ(sc, MII_BMCR);
195 	if (bmcr & BMCR_ISO) {
196 		mii->mii_media_active |= IFM_NONE;
197 		mii->mii_media_status = 0;
198 		return;
199 	}
200 
201 	if (bmcr & BMCR_LOOP)
202 		mii->mii_media_active |= IFM_LOOP;
203 
204 	if (bmcr & BMCR_AUTOEN) {
205 		/*
206 		 * The media status bits are only valid if autonegotiation
207 		 * has completed (or it's disabled).
208 		 */
209 		if ((bmsr & BMSR_ACOMP) == 0) {
210 			/* Erg, still trying, I guess... */
211 			mii->mii_media_active |= IFM_NONE;
212 			return;
213 		}
214 
215 		switch (physup & (PHY_SUP_SPEED1 | PHY_SUP_SPEED0)) {
216 		case PHY_SUP_SPEED1:
217 			mii->mii_media_active |= IFM_1000_T;
218 			gtsr = PHY_READ(sc, MII_100T2SR);
219 			if (gtsr & GTSR_MS_RES)
220 				mii->mii_media_active |= IFM_ETH_MASTER;
221 			break;
222 
223 		case PHY_SUP_SPEED0:
224 			mii->mii_media_active |= IFM_100_TX;
225 			break;
226 
227 		case 0:
228 			mii->mii_media_active |= IFM_10_T;
229 			break;
230 
231 		default:
232 			mii->mii_media_active |= IFM_NONE;
233 			mii->mii_media_status = 0;
234 			return;
235 		}
236 
237 		if (physup & PHY_SUP_DUPLEX)
238 			mii->mii_media_active |=
239 			    IFM_FDX | mii_phy_flowstatus(sc);
240 		else
241 			mii->mii_media_active |= IFM_HDX;
242 	} else
243 		mii->mii_media_active = ife->ifm_media;
244 }
245