1/*-
2 * SPDX-License-Identifier: BSD-4-Clause
3 *
4 * Copyright (c) 2000
5 *	Bill Paul <wpaul@ee.columbia.edu>.  All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 *    must display the following acknowledgement:
17 *	This product includes software developed by Bill Paul.
18 * 4. Neither the name of the author nor the names of any co-contributors
19 *    may be used to endorse or promote products derived from this software
20 *    without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32 * THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35#include <sys/cdefs.h>
36__FBSDID("$FreeBSD: releng/12.0/sys/dev/mii/xmphy.c 325966 2017-11-18 14:26:50Z pfg $");
37
38/*
39 * driver for the XaQti XMAC II's internal PHY. This is sort of
40 * like a 10/100 PHY, except the only thing we're really autoselecting
41 * here is full/half duplex. Speed is always 1000mbps.
42 */
43
44#include <sys/param.h>
45#include <sys/systm.h>
46#include <sys/kernel.h>
47#include <sys/module.h>
48#include <sys/socket.h>
49#include <sys/bus.h>
50
51#include <net/if.h>
52#include <net/if_media.h>
53
54#include <dev/mii/mii.h>
55#include <dev/mii/miivar.h>
56#include "miidevs.h"
57
58#include <dev/mii/xmphyreg.h>
59
60#include "miibus_if.h"
61
62static int xmphy_probe(device_t);
63static int xmphy_attach(device_t);
64
65static device_method_t xmphy_methods[] = {
66	/* device interface */
67	DEVMETHOD(device_probe,		xmphy_probe),
68	DEVMETHOD(device_attach,	xmphy_attach),
69	DEVMETHOD(device_detach,	mii_phy_detach),
70	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
71	DEVMETHOD_END
72};
73
74static devclass_t xmphy_devclass;
75
76static driver_t xmphy_driver = {
77	"xmphy",
78	xmphy_methods,
79	sizeof(struct mii_softc)
80};
81
82DRIVER_MODULE(xmphy, miibus, xmphy_driver, xmphy_devclass, 0, 0);
83
84static int	xmphy_service(struct mii_softc *, struct mii_data *, int);
85static void	xmphy_status(struct mii_softc *);
86static int	xmphy_mii_phy_auto(struct mii_softc *);
87
88static const struct mii_phydesc xmphys[] = {
89	MII_PHY_DESC(xxJATO, BASEX),
90	MII_PHY_DESC(xxXAQTI, XMACII),
91	MII_PHY_END
92};
93
94static const struct mii_phy_funcs xmphy_funcs = {
95	xmphy_service,
96	xmphy_status,
97	mii_phy_reset
98};
99
100static int
101xmphy_probe(device_t dev)
102{
103
104	return (mii_phy_dev_probe(dev, xmphys, BUS_PROBE_DEFAULT));
105}
106
107static int
108xmphy_attach(device_t dev)
109{
110	struct mii_softc *sc;
111	const char *sep = "";
112
113	sc = device_get_softc(dev);
114
115	mii_phy_dev_attach(dev, MIIF_NOISOLATE | MIIF_NOMANPAUSE,
116	    &xmphy_funcs, 0);
117	sc->mii_anegticks = MII_ANEGTICKS;
118
119	PHY_RESET(sc);
120
121#define	ADD(m)		ifmedia_add(&sc->mii_pdata->mii_media, (m), 0, NULL)
122#define PRINT(s)	printf("%s%s", sep, s); sep = ", "
123
124	device_printf(dev, " ");
125	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0, sc->mii_inst));
126	PRINT("1000baseSX");
127	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst));
128	PRINT("1000baseSX-FDX");
129	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst));
130	PRINT("auto");
131
132	printf("\n");
133
134#undef ADD
135#undef PRINT
136
137	MIIBUS_MEDIAINIT(sc->mii_dev);
138	return (0);
139}
140
141static int
142xmphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
143{
144	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
145	int reg;
146
147	switch (cmd) {
148	case MII_POLLSTAT:
149		break;
150
151	case MII_MEDIACHG:
152		switch (IFM_SUBTYPE(ife->ifm_media)) {
153		case IFM_AUTO:
154#ifdef foo
155			/*
156			 * If we're already in auto mode, just return.
157			 */
158			if (PHY_READ(sc, XMPHY_MII_BMCR) & XMPHY_BMCR_AUTOEN)
159				return (0);
160#endif
161			(void)xmphy_mii_phy_auto(sc);
162			break;
163		case IFM_1000_SX:
164			PHY_RESET(sc);
165			if ((ife->ifm_media & IFM_FDX) != 0) {
166				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
167				PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
168			} else {
169				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
170				PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
171			}
172			break;
173		default:
174			return (EINVAL);
175		}
176		break;
177
178	case MII_TICK:
179		/*
180		 * Only used for autonegotiation.
181		 */
182		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
183			break;
184
185		/*
186		 * Check to see if we have link.  If we do, we don't
187		 * need to restart the autonegotiation process.  Read
188		 * the BMSR twice in case it's latched.
189		 */
190		reg = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
191		if (reg & BMSR_LINK)
192			break;
193
194		/* Only retry autonegotiation every mii_anegticks seconds. */
195		if (sc->mii_ticks <= sc->mii_anegticks)
196			break;
197
198		sc->mii_ticks = 0;
199
200		PHY_RESET(sc);
201		xmphy_mii_phy_auto(sc);
202		return (0);
203	}
204
205	/* Update the media status. */
206	xmphy_status(sc);
207
208	/* Callback if something changed. */
209	mii_phy_update(sc, cmd);
210	return (0);
211}
212
213static void
214xmphy_status(struct mii_softc *sc)
215{
216	struct mii_data *mii = sc->mii_pdata;
217	int bmsr, bmcr, anlpar;
218
219	mii->mii_media_status = IFM_AVALID;
220	mii->mii_media_active = IFM_ETHER;
221
222	bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
223	    PHY_READ(sc, XMPHY_MII_BMSR);
224	if (bmsr & XMPHY_BMSR_LINK)
225		mii->mii_media_status |= IFM_ACTIVE;
226
227	/* Do dummy read of extended status register. */
228	bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);
229
230	bmcr = PHY_READ(sc, XMPHY_MII_BMCR);
231
232	if (bmcr & XMPHY_BMCR_LOOP)
233		mii->mii_media_active |= IFM_LOOP;
234
235	if (bmcr & XMPHY_BMCR_AUTOEN) {
236		if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
237			if (bmsr & XMPHY_BMSR_LINK) {
238				mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
239				return;
240			}
241			/* Erg, still trying, I guess... */
242			mii->mii_media_active |= IFM_NONE;
243			return;
244		}
245
246		mii->mii_media_active |= IFM_1000_SX;
247		anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
248		    PHY_READ(sc, XMPHY_MII_ANLPAR);
249		if (anlpar & XMPHY_ANLPAR_FDX)
250			mii->mii_media_active |= IFM_FDX;
251		else
252			mii->mii_media_active |= IFM_HDX;
253		return;
254	}
255
256	mii->mii_media_active |= IFM_1000_SX;
257	if (bmcr & XMPHY_BMCR_FDX)
258		mii->mii_media_active |= IFM_FDX;
259	else
260		mii->mii_media_active |= IFM_HDX;
261}
262
263static int
264xmphy_mii_phy_auto(struct mii_softc *mii)
265{
266	int anar = 0;
267
268	anar = PHY_READ(mii, XMPHY_MII_ANAR);
269	anar |= XMPHY_ANAR_FDX|XMPHY_ANAR_HDX;
270	PHY_WRITE(mii, XMPHY_MII_ANAR, anar);
271	DELAY(1000);
272	PHY_WRITE(mii, XMPHY_MII_BMCR,
273	    XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);
274
275	return (EJUSTRETURN);
276}
277