1/*	$NetBSD: inphy.c,v 1.60 2020/03/15 23:04:50 thorpej Exp $	*/
2
3/*-
4 * Copyright (c) 1998, 1999, 2000 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
57/*
58 * driver for Intel's i82555 ethernet 10/100 PHY
59 * Data Sheet available from www.intel.com
60 */
61
62#include <sys/cdefs.h>
63__KERNEL_RCSID(0, "$NetBSD: inphy.c,v 1.60 2020/03/15 23:04:50 thorpej Exp $");
64
65#include <sys/param.h>
66#include <sys/systm.h>
67#include <sys/kernel.h>
68#include <sys/device.h>
69#include <sys/socket.h>
70#include <sys/errno.h>
71
72#include <net/if.h>
73#include <net/if_media.h>
74
75#include <dev/mii/mii.h>
76#include <dev/mii/miivar.h>
77#include <dev/mii/miidevs.h>
78
79#include <dev/mii/inphyreg.h>
80
81static int	inphymatch(device_t, cfdata_t, void *);
82static void	inphyattach(device_t, device_t, void *);
83
84CFATTACH_DECL_NEW(inphy, sizeof(struct mii_softc),
85    inphymatch, inphyattach, mii_phy_detach, mii_phy_activate);
86
87static int	inphy_service(struct mii_softc *, struct mii_data *, int);
88static void	inphy_status(struct mii_softc *);
89
90static const struct mii_phy_funcs inphy_funcs = {
91	inphy_service, inphy_status, mii_phy_reset,
92};
93
94static const struct mii_phydesc inphys[] = {
95	MII_PHY_DESC(yyINTEL, I82555),
96	MII_PHY_DESC(yyINTEL, I82562EH),
97	MII_PHY_DESC(yyINTEL, I82562EM),
98	MII_PHY_DESC(yyINTEL, I82562ET),
99	MII_PHY_DESC(yyINTEL, I82562G),
100	MII_PHY_END,
101};
102
103static int
104inphymatch(device_t parent, cfdata_t match, void *aux)
105{
106	struct mii_attach_args *ma = aux;
107
108	if (mii_phy_match(ma, inphys) != NULL)
109		return 10;
110
111	return 0;
112}
113
114static void
115inphyattach(device_t parent, device_t self, void *aux)
116{
117	struct mii_softc *sc = device_private(self);
118	struct mii_attach_args *ma = aux;
119	struct mii_data *mii = ma->mii_data;
120	const struct mii_phydesc *mpd;
121
122	mpd = mii_phy_match(ma, inphys);
123	aprint_naive(": Media interface\n");
124	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
125
126	sc->mii_dev = self;
127	sc->mii_inst = mii->mii_instance;
128	sc->mii_phy = ma->mii_phyno;
129	sc->mii_mpd_oui = MII_OUI(ma->mii_id1, ma->mii_id2);
130	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
131	sc->mii_mpd_rev = MII_REV(ma->mii_id2);
132	sc->mii_funcs = &inphy_funcs;
133	sc->mii_pdata = mii;
134	sc->mii_flags = ma->mii_flags;
135
136	mii_lock(mii);
137
138	PHY_RESET(sc);
139
140	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
141	sc->mii_capabilities &= ma->mii_capmask;
142
143	mii_unlock(mii);
144
145	mii_phy_add_media(sc);
146}
147
148static int
149inphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
150{
151	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
152	uint16_t reg;
153
154	KASSERT(mii_locked(mii));
155
156	switch (cmd) {
157	case MII_POLLSTAT:
158		/* If we're not polling our PHY instance, just return. */
159		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
160			return 0;
161		break;
162
163	case MII_MEDIACHG:
164		/*
165		 * If the media indicates a different PHY instance,
166		 * isolate ourselves.
167		 */
168		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
169			PHY_READ(sc, MII_BMCR, &reg);
170			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
171			return 0;
172		}
173
174		/* If the interface is not up, don't do anything. */
175		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
176			break;
177
178		mii_phy_setmedia(sc);
179		break;
180
181	case MII_TICK:
182		/* If we're not currently selected, just return. */
183		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
184			return 0;
185
186		if (mii_phy_tick(sc) == EJUSTRETURN)
187			return 0;
188		break;
189
190	case MII_DOWN:
191		mii_phy_down(sc);
192		return 0;
193	}
194
195	/* Update the media status. */
196	mii_phy_status(sc);
197
198	/* Callback if something changed. */
199	mii_phy_update(sc, cmd);
200	return 0;
201}
202
203static void
204inphy_status(struct mii_softc *sc)
205{
206	struct mii_data *mii = sc->mii_pdata;
207	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
208	uint16_t bmsr, bmcr, scr;
209
210	KASSERT(mii_locked(mii));
211
212	mii->mii_media_status = IFM_AVALID;
213	mii->mii_media_active = IFM_ETHER;
214
215	PHY_READ(sc, MII_BMSR, &bmsr);
216	PHY_READ(sc, MII_BMSR, &bmsr);
217	if (bmsr & BMSR_LINK)
218		mii->mii_media_status |= IFM_ACTIVE;
219
220	PHY_READ(sc, MII_BMCR, &bmcr);
221	if (bmcr & BMCR_ISO) {
222		mii->mii_media_active |= IFM_NONE;
223		mii->mii_media_status = 0;
224		return;
225	}
226
227	if (bmcr & BMCR_LOOP)
228		mii->mii_media_active |= IFM_LOOP;
229
230	if (bmcr & BMCR_AUTOEN) {
231		if ((bmsr & BMSR_ACOMP) == 0) {
232			/* Erg, still trying, I guess... */
233			mii->mii_media_active |= IFM_NONE;
234			return;
235		}
236
237		PHY_READ(sc, MII_INPHY_SCR, &scr);
238		if (scr & SCR_S100)
239			mii->mii_media_active |= IFM_100_TX;
240		else if ((bmsr & BMSR_100T4) && (scr & SCR_T4))
241			mii->mii_media_active |= IFM_100_T4;
242		else
243			mii->mii_media_active |= IFM_10_T;
244
245		if (scr & SCR_FDX)
246			mii->mii_media_active |= IFM_FDX;
247		else
248			mii->mii_media_active |= IFM_HDX;
249
250		if (mii->mii_media_active & IFM_FDX)
251			mii->mii_media_active |= mii_phy_flowstatus(sc);
252	} else
253		mii->mii_media_active = ife->ifm_media;
254}
255