1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-NetBSD
3 *
4 * Copyright (c) 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9 * NASA Ames Research Center.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 *    notice, this list of conditions and the following disclaimer in the
18 *    documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33/*
34 * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 * 1. Redistributions of source code must retain the above copyright
40 *    notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 *    notice, this list of conditions and the following disclaimer in the
43 *    documentation and/or other materials provided with the distribution.
44 *
45 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
46 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
47 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
48 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
49 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
54 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55 *
56 *	from: NetBSD: bmtphy.c,v 1.8 2002/07/03 06:25:50 simonb Exp
57 *
58 */
59
60#include <sys/cdefs.h>
61__FBSDID("$FreeBSD: releng/12.0/sys/dev/mii/bmtphy.c 326255 2017-11-27 14:52:40Z pfg $");
62
63/*
64 * Driver for the Broadcom BCM5201/BCM5202 "Mini-Theta" PHYs.  This also
65 * drives the PHY on the 3Com 3c905C.  The 3c905C's PHY is described in
66 * the 3c905C data sheet.
67 */
68
69#include <sys/param.h>
70#include <sys/systm.h>
71#include <sys/kernel.h>
72#include <sys/module.h>
73#include <sys/socket.h>
74#include <sys/bus.h>
75
76#include <net/if.h>
77#include <net/if_media.h>
78
79#include <dev/mii/mii.h>
80#include <dev/mii/miivar.h>
81#include "miidevs.h"
82
83#include <dev/mii/bmtphyreg.h>
84
85#include "miibus_if.h"
86
87static int	bmtphy_probe(device_t);
88static int	bmtphy_attach(device_t);
89
90static device_method_t bmtphy_methods[] = {
91	/* Device interface */
92	DEVMETHOD(device_probe,		bmtphy_probe),
93	DEVMETHOD(device_attach,	bmtphy_attach),
94	DEVMETHOD(device_detach,	mii_phy_detach),
95	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
96	DEVMETHOD_END
97};
98
99static devclass_t	bmtphy_devclass;
100
101static driver_t	bmtphy_driver = {
102	"bmtphy",
103	bmtphy_methods,
104	sizeof(struct mii_softc)
105};
106
107DRIVER_MODULE(bmtphy, miibus, bmtphy_driver, bmtphy_devclass, 0, 0);
108
109static int	bmtphy_service(struct mii_softc *, struct mii_data *, int);
110static void	bmtphy_status(struct mii_softc *);
111static void	bmtphy_reset(struct mii_softc *);
112
113static const struct mii_phydesc bmtphys_dp[] = {
114	MII_PHY_DESC(xxBROADCOM, BCM4401),
115	MII_PHY_DESC(xxBROADCOM, BCM5201),
116	MII_PHY_DESC(xxBROADCOM, BCM5214),
117	MII_PHY_DESC(xxBROADCOM, BCM5221),
118	MII_PHY_DESC(xxBROADCOM, BCM5222),
119	MII_PHY_END
120};
121
122static const struct mii_phydesc bmtphys_lp[] = {
123	MII_PHY_DESC(xxBROADCOM, 3C905B),
124	MII_PHY_DESC(xxBROADCOM, 3C905C),
125	MII_PHY_END
126};
127
128static const struct mii_phy_funcs bmtphy_funcs = {
129	bmtphy_service,
130	bmtphy_status,
131	bmtphy_reset
132};
133
134static int
135bmtphy_probe(device_t dev)
136{
137	int	rval;
138
139	/* Let exphy(4) take precedence for these. */
140	rval = mii_phy_dev_probe(dev, bmtphys_lp, BUS_PROBE_LOW_PRIORITY);
141#ifndef __HAIKU__
142	if (rval <= 0)
143		return (rval);
144#else /* __HAIKU__ */
145	/* our BUS_PROBE_* constants are > 0 since errors are < 0 */
146	if (rval > 0)
147		return (rval);
148#endif
149	return (mii_phy_dev_probe(dev, bmtphys_dp, BUS_PROBE_DEFAULT));
150}
151
152static int
153bmtphy_attach(device_t dev)
154{
155
156	mii_phy_dev_attach(dev, MIIF_NOMANPAUSE, &bmtphy_funcs, 1);
157	return (0);
158}
159
160static int
161bmtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
162{
163
164	switch (cmd) {
165	case MII_POLLSTAT:
166		break;
167
168	case MII_MEDIACHG:
169		mii_phy_setmedia(sc);
170		break;
171
172	case MII_TICK:
173		if (mii_phy_tick(sc) == EJUSTRETURN)
174			return (0);
175		break;
176	}
177
178	/* Update the media status. */
179	PHY_STATUS(sc);
180
181	/* Callback if something changed. */
182	mii_phy_update(sc, cmd);
183	return (0);
184}
185
186static void
187bmtphy_status(struct mii_softc *sc)
188{
189	struct mii_data *mii;
190	struct ifmedia_entry *ife;
191	int bmsr, bmcr, aux_csr;
192
193	mii = sc->mii_pdata;
194	ife = mii->mii_media.ifm_cur;
195
196	mii->mii_media_status = IFM_AVALID;
197	mii->mii_media_active = IFM_ETHER;
198
199	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
200
201	if (bmsr & BMSR_LINK)
202		mii->mii_media_status |= IFM_ACTIVE;
203
204	bmcr = PHY_READ(sc, MII_BMCR);
205	if (bmcr & BMCR_ISO) {
206		mii->mii_media_active |= IFM_NONE;
207		mii->mii_media_status = 0;
208		return;
209	}
210
211	if (bmcr & BMCR_LOOP)
212		mii->mii_media_active |= IFM_LOOP;
213
214	if (bmcr & BMCR_AUTOEN) {
215		/*
216		 * The media status bits are only valid if autonegotiation
217		 * has completed (or it's disabled).
218		 */
219		if ((bmsr & BMSR_ACOMP) == 0) {
220			/* Erg, still trying, I guess... */
221			mii->mii_media_active |= IFM_NONE;
222			return;
223		}
224
225		aux_csr = PHY_READ(sc, MII_BMTPHY_AUX_CSR);
226		if (aux_csr & AUX_CSR_SPEED)
227			mii->mii_media_active |= IFM_100_TX;
228		else
229			mii->mii_media_active |= IFM_10_T;
230		if (aux_csr & AUX_CSR_FDX)
231			mii->mii_media_active |=
232			    IFM_FDX | mii_phy_flowstatus(sc);
233		else
234			mii->mii_media_active |= IFM_HDX;
235	} else
236		mii->mii_media_active = ife->ifm_media;
237}
238
239static void
240bmtphy_reset(struct mii_softc *sc)
241{
242	u_int16_t data;
243
244	mii_phy_reset(sc);
245
246	if (sc->mii_mpd_model == MII_MODEL_xxBROADCOM_BCM5221) {
247		/* Enable shadow register mode. */
248		data = PHY_READ(sc, 0x1f);
249		PHY_WRITE(sc, 0x1f, data | 0x0080);
250
251		/* Enable APD (Auto PowerDetect). */
252		data = PHY_READ(sc, MII_BMTPHY_AUX2);
253		PHY_WRITE(sc, MII_BMTPHY_AUX2, data | 0x0020);
254
255		/* Enable clocks across APD for Auto-MDIX functionality. */
256		data = PHY_READ(sc, MII_BMTPHY_INTR);
257		PHY_WRITE(sc, MII_BMTPHY_INTR, data | 0x0004);
258
259		/* Disable shadow register mode. */
260		data = PHY_READ(sc, 0x1f);
261		PHY_WRITE(sc, 0x1f, data & ~0x0080);
262	}
263}
264