1/*	$NetBSD: tqphy.c,v 1.45 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 * TDK TSC78Q2120 PHY driver
59 *
60 * Documentation available at http://www.tsc.tdk.com/lan/78Q2120.pdf .
61 */
62
63#include <sys/cdefs.h>
64__KERNEL_RCSID(0, "$NetBSD: tqphy.c,v 1.45 2020/03/15 23:04:50 thorpej Exp $");
65
66#include <sys/param.h>
67#include <sys/systm.h>
68#include <sys/kernel.h>
69#include <sys/device.h>
70#include <sys/socket.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/tqphyreg.h>
80
81static int	tqphymatch(device_t, cfdata_t, void *);
82static void	tqphyattach(device_t, device_t, void *);
83
84CFATTACH_DECL_NEW(tqphy, sizeof(struct mii_softc),
85    tqphymatch, tqphyattach, mii_phy_detach, mii_phy_activate);
86
87static int	tqphy_service(struct mii_softc *, struct mii_data *, int);
88static void	tqphy_status(struct mii_softc *);
89
90static const struct mii_phy_funcs tqphy_funcs = {
91	tqphy_service, tqphy_status, mii_phy_reset,
92};
93
94static const struct mii_phydesc tqphys[] = {
95	MII_PHY_DESC(xxTSC, 78Q2120),
96#if 0
97	MII_PHY_DESC(xxTSC, 78Q2121),
98#endif
99	MII_PHY_END,
100};
101
102static int
103tqphymatch(device_t parent, cfdata_t match, void *aux)
104{
105	struct mii_attach_args *ma = aux;
106
107	if (mii_phy_match(ma, tqphys) != NULL) {
108		/* The DIAG register is unreliable on early revisions. */
109		if (MII_MODEL(ma->mii_id2) == MII_MODEL_xxTSC_78Q2120 &&
110		    MII_REV(ma->mii_id2) <= 3)
111			return 0;
112		return 10;
113	}
114
115	return 0;
116}
117
118static void
119tqphyattach(device_t parent, device_t self, void *aux)
120{
121	struct mii_softc *sc = device_private(self);
122	struct mii_attach_args *ma = aux;
123	struct mii_data *mii = ma->mii_data;
124	const struct mii_phydesc *mpd;
125
126	mpd = mii_phy_match(ma, tqphys);
127	aprint_naive(": Media interface\n");
128	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
129
130	sc->mii_dev = self;
131	sc->mii_inst = mii->mii_instance;
132	sc->mii_phy = ma->mii_phyno;
133	sc->mii_funcs = &tqphy_funcs;
134	sc->mii_pdata = mii;
135	sc->mii_flags = ma->mii_flags;
136
137	/* Apparently, we can't do loopback on this PHY. */
138	sc->mii_flags |= MIIF_NOLOOP;
139
140	mii_lock(mii);
141
142	PHY_RESET(sc);
143
144	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
145	sc->mii_capabilities &= ma->mii_capmask;
146
147	mii_unlock(mii);
148
149	mii_phy_add_media(sc);
150}
151
152static int
153tqphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
154{
155	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
156	uint16_t reg;
157
158	KASSERT(mii_locked(mii));
159
160	switch (cmd) {
161	case MII_POLLSTAT:
162		/* If we're not polling our PHY instance, just return. */
163		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
164			return 0;
165		break;
166
167	case MII_MEDIACHG:
168		/*
169		 * If the media indicates a different PHY instance,
170		 * isolate ourselves.
171		 */
172		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
173			PHY_READ(sc, MII_BMCR, &reg);
174			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
175			return 0;
176		}
177
178		/* If the interface is not up, don't do anything. */
179		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
180			break;
181
182		mii_phy_setmedia(sc);
183		break;
184
185	case MII_TICK:
186		/* If we're not currently selected, just return. */
187		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
188			return 0;
189
190		if (mii_phy_tick(sc) == EJUSTRETURN)
191			return 0;
192		break;
193
194	case MII_DOWN:
195		mii_phy_down(sc);
196		return 0;
197	}
198
199	/* Update the media status. */
200	mii_phy_status(sc);
201
202	/* Callback if something changed. */
203	mii_phy_update(sc, cmd);
204	return 0;
205}
206
207static void
208tqphy_status(struct mii_softc *sc)
209{
210	struct mii_data *mii = sc->mii_pdata;
211	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
212	uint16_t bmsr, bmcr, diag;
213
214	KASSERT(mii_locked(mii));
215
216	mii->mii_media_status = IFM_AVALID;
217	mii->mii_media_active = IFM_ETHER;
218
219	PHY_READ(sc, MII_BMSR, &bmsr);
220	PHY_READ(sc, MII_BMSR, &bmsr);
221	if (bmsr & BMSR_LINK)
222		mii->mii_media_status |= IFM_ACTIVE;
223
224	PHY_READ(sc, MII_BMCR, &bmcr);
225	if (bmcr & BMCR_ISO) {
226		mii->mii_media_active |= IFM_NONE;
227		mii->mii_media_status = 0;
228		return;
229	}
230
231	if (bmcr & BMCR_LOOP)
232		mii->mii_media_active |= IFM_LOOP;
233
234	if (bmcr & BMCR_AUTOEN) {
235		if ((bmsr & BMSR_ACOMP) == 0) {
236			/* Erg, still trying, I guess... */
237			mii->mii_media_active |= IFM_NONE;
238			return;
239		}
240		PHY_READ(sc, MII_TQPHY_DIAG, &diag);
241		if (diag & DIAG_RATE)
242			mii->mii_media_active |= IFM_100_TX;
243		else
244			mii->mii_media_active |= IFM_10_T;
245
246		if (diag & DIAG_DPLX)
247			mii->mii_media_active |= IFM_FDX;
248		else
249			mii->mii_media_active |= IFM_HDX;
250	} else
251		mii->mii_media_active = ife->ifm_media;
252}
253