1/*	$NetBSD: ukphy.c,v 1.55 2021/06/29 21:03:36 pgoyette 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, and by Frank van der Linden.
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 generic unknown PHYs
59 */
60
61#include <sys/cdefs.h>
62__KERNEL_RCSID(0, "$NetBSD: ukphy.c,v 1.55 2021/06/29 21:03:36 pgoyette Exp $");
63
64#ifdef _KERNEL_OPT
65#include "opt_mii.h"
66#endif
67
68#include <sys/param.h>
69#include <sys/systm.h>
70#include <sys/kernel.h>
71#include <sys/device.h>
72#include <sys/socket.h>
73#include <sys/errno.h>
74
75#include <net/if.h>
76#include <net/if_media.h>
77
78#include <dev/mii/mii.h>
79#include <dev/mii/miivar.h>
80
81static int	ukphymatch(device_t, cfdata_t, void *);
82static void	ukphyattach(device_t, device_t, void *);
83
84CFATTACH_DECL_NEW(ukphy, sizeof(struct mii_softc),
85    ukphymatch, ukphyattach, mii_phy_detach, mii_phy_activate);
86
87static int	ukphy_service(struct mii_softc *, struct mii_data *, int);
88
89static const struct mii_phy_funcs ukphy_funcs = {
90	ukphy_service, ukphy_status, mii_phy_reset,
91};
92
93static int
94ukphymatch(device_t parent, cfdata_t match, void *aux)
95{
96
97	/*
98	 * We know something is here, so always match at a low priority.
99	 */
100	return 1;
101}
102
103static void
104ukphyattach(device_t parent, device_t self, void *aux)
105{
106	struct mii_softc *sc = device_private(self);
107	struct mii_attach_args *ma = aux;
108	struct mii_data *mii = ma->mii_data;
109	int oui = MII_OUI(ma->mii_id1, ma->mii_id2);
110	int model = MII_MODEL(ma->mii_id2);
111	int rev = MII_REV(ma->mii_id2);
112	char descr[MII_MAX_DESCR_LEN];
113
114	if (mii_get_descr(descr, sizeof(descr), oui, model) && descr[0])
115		aprint_normal(": %s (OUI 0x%06x, model 0x%04x), rev. %d\n",
116		       descr, oui, model, rev);
117	else
118		aprint_normal(": OUI 0x%06x, model 0x%04x, rev. %d\n",
119		       oui, model, rev);
120	aprint_naive(": Media interface\n");
121
122	sc->mii_dev = self;
123	sc->mii_inst = mii->mii_instance;
124	sc->mii_phy = ma->mii_phyno;
125	sc->mii_mpd_oui = MII_OUI(ma->mii_id1, ma->mii_id2);
126	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
127	sc->mii_mpd_rev = MII_REV(ma->mii_id2);
128	sc->mii_funcs = &ukphy_funcs;
129	sc->mii_pdata = mii;
130	sc->mii_flags = ma->mii_flags;
131
132	/*
133	 * Don't do loopback on unknown PHYs.  It might confuse some of them.
134	 */
135	sc->mii_flags |= MIIF_NOLOOP;
136
137	mii_lock(mii);
138
139	PHY_RESET(sc);
140
141	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
142	sc->mii_capabilities &= ma->mii_capmask;
143	if (sc->mii_capabilities & BMSR_EXTSTAT)
144		PHY_READ(sc, MII_EXTSR, &sc->mii_extcapabilities);
145
146	mii_unlock(mii);
147
148	mii_phy_add_media(sc);
149}
150
151static int
152ukphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
153{
154	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
155	uint16_t reg;
156
157	KASSERT(mii_locked(mii));
158
159	switch (cmd) {
160	case MII_POLLSTAT:
161		/* If we're not polling our PHY instance, just return. */
162		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
163			return 0;
164		break;
165
166	case MII_MEDIACHG:
167		/*
168		 * If the media indicates a different PHY instance,
169		 * isolate ourselves.
170		 */
171		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
172			PHY_READ(sc, MII_BMCR, &reg);
173			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
174			return 0;
175		}
176
177		/* If the interface is not up, don't do anything. */
178		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
179			break;
180
181		mii_phy_setmedia(sc);
182		break;
183
184	case MII_TICK:
185		/* If we're not currently selected, just return. */
186		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
187			return 0;
188
189		if (mii_phy_tick(sc) == EJUSTRETURN)
190			return 0;
191		break;
192
193	case MII_DOWN:
194		mii_phy_down(sc);
195		return 0;
196	}
197
198	/* Update the media status. */
199	mii_phy_status(sc);
200
201	/* Callback if something changed. */
202	mii_phy_update(sc, cmd);
203	return 0;
204}
205