1/*	$OpenBSD: bmtphy.c,v 1.22 2023/03/04 22:34:37 kettenis Exp $	*/
2/*	$NetBSD: bmtphy.c,v 1.17 2005/01/17 13:17:45 scw Exp $	*/
3/*
4 * Copyright (c) 2001 Theo de Raadt
5 *
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18
19/*
20 * Driver for Broadcom BCM5201/BCM5202 "Mini-Theta" PHYs.  This also
21 * drives the PHY on the 3Com 3c905C.  The 3c905C's PHY is described in
22 * the 3c905C data sheet.
23 */
24
25#include <sys/param.h>
26#include <sys/systm.h>
27#include <sys/device.h>
28#include <sys/socket.h>
29#include <sys/errno.h>
30
31#include <net/if.h>
32#include <net/if_var.h>
33#include <net/if_media.h>
34
35#include <dev/mii/mii.h>
36#include <dev/mii/miivar.h>
37#include <dev/mii/miidevs.h>
38
39#include <dev/mii/bmtphyreg.h>
40
41int	bmtphymatch(struct device *, void *, void *);
42void	bmtphyattach(struct device *, struct device *, void *);
43
44const struct cfattach bmtphy_ca = {
45	sizeof(struct mii_softc), bmtphymatch, bmtphyattach, mii_phy_detach
46};
47
48struct cfdriver bmtphy_cd = {
49	NULL, "bmtphy", DV_DULL
50};
51
52int	bmtphy_service(struct mii_softc *, struct mii_data *, int);
53void	bmtphy_status(struct mii_softc *);
54void	bmtphy_reset(struct mii_softc *);
55
56const struct mii_phy_funcs bmtphy_funcs = {
57	bmtphy_service, bmtphy_status, bmtphy_reset,
58};
59
60static const struct mii_phydesc bmtphys[] = {
61	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_3C905B,
62	  MII_STR_BROADCOM_3C905B },
63	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_3C905C,
64	  MII_STR_BROADCOM_3C905C },
65	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM4401,
66	  MII_STR_BROADCOM_BCM4401 },
67	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5201,
68	  MII_STR_BROADCOM_BCM5201 },
69	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5214,
70	  MII_STR_BROADCOM_BCM5214 },
71	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5220,
72	  MII_STR_BROADCOM_BCM5220 },
73	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5221,
74	  MII_STR_BROADCOM_BCM5221 },
75	{ MII_OUI_BROADCOM,		MII_MODEL_BROADCOM_BCM5222,
76	  MII_STR_BROADCOM_BCM5222 },
77
78	{ 0,				0,
79	  NULL },
80};
81
82int
83bmtphymatch(struct device *parent, void *match, void *aux)
84{
85	struct mii_attach_args *ma = aux;
86
87	if (mii_phy_match(ma, bmtphys) != NULL)
88		return (10);
89
90	return (0);
91}
92
93void
94bmtphyattach(struct device *parent, struct device *self, void *aux)
95{
96	struct mii_softc *sc = (struct mii_softc *)self;
97	struct mii_attach_args *ma = aux;
98	struct mii_data *mii = ma->mii_data;
99	const struct mii_phydesc *mpd;
100
101	mpd = mii_phy_match(ma, bmtphys);
102	printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
103
104	sc->mii_model = MII_MODEL(ma->mii_id2);
105	sc->mii_inst = mii->mii_instance;
106	sc->mii_phy = ma->mii_phyno;
107	sc->mii_funcs = &bmtphy_funcs;
108	sc->mii_pdata = mii;
109	sc->mii_flags = ma->mii_flags;
110	sc->mii_anegticks = MII_ANEGTICKS;
111
112	PHY_RESET(sc);
113
114	/*
115	 * XXX Check AUX_STS_FX_MODE to set MIIF_HAVE_FIBER?
116	 */
117
118	sc->mii_capabilities =
119	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
120	if (sc->mii_capabilities & BMSR_MEDIAMASK)
121		mii_phy_add_media(sc);
122}
123
124int
125bmtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
126{
127	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
128	int reg;
129
130	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
131		return (ENXIO);
132
133	switch (cmd) {
134	case MII_POLLSTAT:
135		/*
136		 * If we're not polling our PHY instance, just return.
137		 */
138		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
139			return (0);
140		break;
141
142	case MII_MEDIACHG:
143		/*
144		 * If the media indicates a different PHY instance,
145		 * isolate ourselves.
146		 */
147		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
148			reg = PHY_READ(sc, MII_BMCR);
149			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
150			return (0);
151		}
152
153		/*
154		 * If the interface is not up, don't do anything.
155		 */
156		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
157			break;
158
159		mii_phy_setmedia(sc);
160		break;
161
162	case MII_TICK:
163		/*
164		 * If we're not currently selected, just return.
165		 */
166		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
167			return (0);
168
169		if (mii_phy_tick(sc) == EJUSTRETURN)
170			return (0);
171		break;
172
173	case MII_DOWN:
174		mii_phy_down(sc);
175		return (0);
176	}
177
178	/* Update the media status. */
179	mii_phy_status(sc);
180
181	/* Callback if something changed. */
182	mii_phy_update(sc, cmd);
183	return (0);
184}
185
186void
187bmtphy_status(struct mii_softc *sc)
188{
189	struct mii_data *mii = sc->mii_pdata;
190	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
191	int bmsr, bmcr, aux_csr;
192
193	mii->mii_media_status = IFM_AVALID;
194	mii->mii_media_active = IFM_ETHER;
195
196	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
197	if (bmsr & BMSR_LINK)
198		mii->mii_media_status |= IFM_ACTIVE;
199
200	bmcr = PHY_READ(sc, MII_BMCR);
201	if (bmcr & BMCR_ISO) {
202		mii->mii_media_active |= IFM_NONE;
203		mii->mii_media_status = 0;
204		return;
205	}
206
207	if (bmcr & BMCR_LOOP)
208		mii->mii_media_active |= IFM_LOOP;
209
210	if (bmcr & BMCR_AUTOEN) {
211		/*
212		 * The later are only valid if autonegotiation
213		 * has completed (or it's disabled).
214		 */
215		if ((bmsr & BMSR_ACOMP) == 0) {
216			/* Erg, still trying, I guess... */
217			mii->mii_media_active |= IFM_NONE;
218			return;
219		}
220
221		aux_csr = PHY_READ(sc, MII_BMTPHY_AUX_CSR);
222		if (aux_csr & AUX_CSR_SPEED)
223			mii->mii_media_active |= IFM_100_TX;
224		else
225			mii->mii_media_active |= IFM_10_T;
226
227		if (aux_csr & AUX_CSR_FDX)
228			mii->mii_media_active |= mii_phy_flowstatus(sc) | IFM_FDX;
229		else
230			mii->mii_media_active |= IFM_HDX;
231	} else
232		mii->mii_media_active = ife->ifm_media;
233}
234
235void
236bmtphy_reset(struct mii_softc *sc)
237{
238	u_int16_t data;
239
240	mii_phy_reset(sc);
241
242	if (sc->mii_model == MII_MODEL_BROADCOM_BCM5221) {
243		/* Enable shadow register mode */
244		data = PHY_READ(sc, 0x1f);
245		PHY_WRITE(sc, 0x1f, data | 0x0080);
246
247		/* Enable APD (Auto PowerDetect) */
248		data = PHY_READ(sc, MII_BMTPHY_AUX2);
249		PHY_WRITE(sc, MII_BMTPHY_AUX2, data | 0x0020);
250
251		/* Enable clocks across APD for
252		 * Auto-MDIX functionality */
253		data = PHY_READ(sc, MII_BMTPHY_INTR);
254		PHY_WRITE(sc, MII_BMTPHY_INTR, data | 0x0004);
255
256		/* Disable shadow register mode */
257		data = PHY_READ(sc, 0x1f);
258		PHY_WRITE(sc, 0x1f, data & ~0x0080);
259	}
260}
261