xref: /freebsd/sys/dev/mii/nsgphy.c (revision 81ad6265)
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 __FBSDID("$FreeBSD$");
44 
45 /*
46  * Driver for the National Semiconductor DP83861, DP83865 and DP83891
47  * 10/100/1000 PHYs.
48  * Datasheet available at: http://www.national.com/ds/DP/DP83861.pdf
49  * and at: http://www.national.com/ds/DP/DP83865.pdf
50  *
51  * The DP83891 is the older NS GigE PHY which isn't being sold
52  * anymore.  The DP83861 is its replacement, which is an 'enhanced'
53  * firmware driven component.  The major difference between the
54  * two is that the DP83891 can't generate interrupts, while the
55  * 83861 can (probably it wasn't originally designed to do this, but
56  * it can now thanks to firmware updates).  The DP83861 also allows
57  * access to its internal RAM via indirect register access.  The
58  * DP83865 is an ultra low power version of the DP83861 and DP83891.
59  */
60 
61 #include <sys/param.h>
62 #include <sys/systm.h>
63 #include <sys/kernel.h>
64 #include <sys/module.h>
65 #include <sys/socket.h>
66 #include <sys/bus.h>
67 
68 #include <net/if.h>
69 #include <net/if_media.h>
70 
71 #include <dev/mii/mii.h>
72 #include <dev/mii/miivar.h>
73 #include "miidevs.h"
74 
75 #include <dev/mii/nsgphyreg.h>
76 
77 #include "miibus_if.h"
78 
79 static int nsgphy_probe(device_t);
80 static int nsgphy_attach(device_t);
81 
82 static device_method_t nsgphy_methods[] = {
83 	/* device interface */
84 	DEVMETHOD(device_probe,		nsgphy_probe),
85 	DEVMETHOD(device_attach,	nsgphy_attach),
86 	DEVMETHOD(device_detach,	mii_phy_detach),
87 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
88 	DEVMETHOD_END
89 };
90 
91 static driver_t nsgphy_driver = {
92 	"nsgphy",
93 	nsgphy_methods,
94 	sizeof(struct mii_softc)
95 };
96 
97 DRIVER_MODULE(nsgphy, miibus, nsgphy_driver, 0, 0);
98 
99 static int	nsgphy_service(struct mii_softc *, struct mii_data *,int);
100 static void	nsgphy_status(struct mii_softc *);
101 
102 static const struct mii_phydesc nsgphys[] = {
103 	MII_PHY_DESC(xxNATSEMI, DP83861),
104 	MII_PHY_DESC(xxNATSEMI, DP83865),
105 	MII_PHY_DESC(xxNATSEMI, DP83891),
106 	MII_PHY_END
107 };
108 
109 static const struct mii_phy_funcs nsgphy_funcs = {
110 	nsgphy_service,
111 	nsgphy_status,
112 	mii_phy_reset
113 };
114 
115 static int
116 nsgphy_probe(device_t dev)
117 {
118 
119 	return (mii_phy_dev_probe(dev, nsgphys, BUS_PROBE_DEFAULT));
120 }
121 
122 static int
123 nsgphy_attach(device_t dev)
124 {
125 	struct mii_softc *sc;
126 
127 	sc = device_get_softc(dev);
128 
129 	mii_phy_dev_attach(dev, MIIF_NOMANPAUSE, &nsgphy_funcs, 0);
130 
131 	PHY_RESET(sc);
132 
133 	/*
134 	 * NB: the PHY has the 10BASE-T BMSR bits hard-wired to 0,
135 	 * even though it supports 10BASE-T.
136 	 */
137 	sc->mii_capabilities = (PHY_READ(sc, MII_BMSR) |
138 	    BMSR_10TFDX | BMSR_10THDX) & sc->mii_capmask;
139 	/*
140 	 * Note that as documented manual 1000BASE-T modes of DP83865 only
141 	 * work together with other National Semiconductor PHYs.
142 	 */
143 	if (sc->mii_capabilities & BMSR_EXTSTAT)
144 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
145 
146 	mii_phy_add_media(sc);
147 	printf("\n");
148 
149 	MIIBUS_MEDIAINIT(sc->mii_dev);
150 	return (0);
151 }
152 
153 static int
154 nsgphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
155 {
156 
157 	switch (cmd) {
158 	case MII_POLLSTAT:
159 		break;
160 
161 	case MII_MEDIACHG:
162 		mii_phy_setmedia(sc);
163 		break;
164 
165 	case MII_TICK:
166 		if (mii_phy_tick(sc) == EJUSTRETURN)
167 			return (0);
168 		break;
169 	}
170 
171 	/* Update the media status. */
172 	PHY_STATUS(sc);
173 
174 	/* Callback if something changed. */
175 	mii_phy_update(sc, cmd);
176 	return (0);
177 }
178 
179 static void
180 nsgphy_status(struct mii_softc *sc)
181 {
182 	struct mii_data *mii = sc->mii_pdata;
183 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
184 	int bmsr, bmcr, physup, gtsr;
185 
186 	mii->mii_media_status = IFM_AVALID;
187 	mii->mii_media_active = IFM_ETHER;
188 
189 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
190 
191 	physup = PHY_READ(sc, NSGPHY_MII_PHYSUP);
192 
193 	if (physup & PHY_SUP_LINK)
194 		mii->mii_media_status |= IFM_ACTIVE;
195 
196 	bmcr = PHY_READ(sc, MII_BMCR);
197 	if (bmcr & BMCR_ISO) {
198 		mii->mii_media_active |= IFM_NONE;
199 		mii->mii_media_status = 0;
200 		return;
201 	}
202 
203 	if (bmcr & BMCR_LOOP)
204 		mii->mii_media_active |= IFM_LOOP;
205 
206 	if (bmcr & BMCR_AUTOEN) {
207 		/*
208 		 * The media status bits are only valid if autonegotiation
209 		 * has completed (or it's disabled).
210 		 */
211 		if ((bmsr & BMSR_ACOMP) == 0) {
212 			/* Erg, still trying, I guess... */
213 			mii->mii_media_active |= IFM_NONE;
214 			return;
215 		}
216 
217 		switch (physup & (PHY_SUP_SPEED1 | PHY_SUP_SPEED0)) {
218 		case PHY_SUP_SPEED1:
219 			mii->mii_media_active |= IFM_1000_T;
220 			gtsr = PHY_READ(sc, MII_100T2SR);
221 			if (gtsr & GTSR_MS_RES)
222 				mii->mii_media_active |= IFM_ETH_MASTER;
223 			break;
224 
225 		case PHY_SUP_SPEED0:
226 			mii->mii_media_active |= IFM_100_TX;
227 			break;
228 
229 		case 0:
230 			mii->mii_media_active |= IFM_10_T;
231 			break;
232 
233 		default:
234 			mii->mii_media_active |= IFM_NONE;
235 			mii->mii_media_status = 0;
236 			return;
237 		}
238 
239 		if (physup & PHY_SUP_DUPLEX)
240 			mii->mii_media_active |=
241 			    IFM_FDX | mii_phy_flowstatus(sc);
242 		else
243 			mii->mii_media_active |= IFM_HDX;
244 	} else
245 		mii->mii_media_active = ife->ifm_media;
246 }
247