xref: /netbsd-src/sys/dev/mii/ukphy.c (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /*	$NetBSD: ukphy.c,v 1.49 2016/07/07 06:55:41 msaitoh 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.49 2016/07/07 06:55:41 msaitoh 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 
81 static int	ukphymatch(device_t, cfdata_t, void *);
82 static void	ukphyattach(device_t, device_t, void *);
83 
84 CFATTACH_DECL3_NEW(ukphy, sizeof(struct mii_softc),
85     ukphymatch, ukphyattach, mii_phy_detach, mii_phy_activate, NULL, NULL,
86     DVF_DETACH_SHUTDOWN);
87 
88 static int	ukphy_service(struct mii_softc *, struct mii_data *, int);
89 
90 static const struct mii_phy_funcs ukphy_funcs = {
91 	ukphy_service, ukphy_status, mii_phy_reset,
92 };
93 
94 static int
95 ukphymatch(device_t parent, cfdata_t match, void *aux)
96 {
97 
98 	/*
99 	 * We know something is here, so always match at a low priority.
100 	 */
101 	return (1);
102 }
103 
104 static void
105 ukphyattach(device_t parent, device_t self, void *aux)
106 {
107 	struct mii_softc *sc = device_private(self);
108 	struct mii_attach_args *ma = aux;
109 	struct mii_data *mii = ma->mii_data;
110 	int oui = MII_OUI(ma->mii_id1, ma->mii_id2);
111 	int model = MII_MODEL(ma->mii_id2);
112 	int rev = MII_REV(ma->mii_id2);
113 	const char *descr;
114 
115 	if ((descr = mii_get_descr(oui, model)) != NULL)
116 		aprint_normal(": %s (OUI 0x%06x, model 0x%04x), rev. %d\n",
117 		       descr, oui, model, rev);
118 	else
119 		aprint_normal(": OUI 0x%06x, model 0x%04x, rev. %d\n",
120 		       oui, model, rev);
121 	aprint_naive(": Media interface\n");
122 
123 	sc->mii_dev = self;
124 	sc->mii_inst = mii->mii_instance;
125 	sc->mii_phy = ma->mii_phyno;
126 	sc->mii_mpd_oui = MII_OUI(ma->mii_id1, ma->mii_id2);
127 	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
128 	sc->mii_mpd_rev = MII_REV(ma->mii_id2);
129 	sc->mii_funcs = &ukphy_funcs;
130 	sc->mii_pdata = mii;
131 	sc->mii_flags = ma->mii_flags;
132 	sc->mii_anegticks = MII_ANEGTICKS;
133 
134 	/*
135 	 * Don't do loopback on unknown PHYs.  It might confuse some of them.
136 	 */
137 	sc->mii_flags |= MIIF_NOLOOP;
138 
139 	PHY_RESET(sc);
140 
141 	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
142 	if (sc->mii_capabilities & BMSR_EXTSTAT)
143 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
144 	aprint_normal_dev(self, "");
145 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
146 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
147 		aprint_error("no media present");
148 	else
149 		mii_phy_add_media(sc);
150 	aprint_normal("\n");
151 }
152 
153 static int
154 ukphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
155 {
156 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
157 	int reg;
158 
159 	switch (cmd) {
160 	case MII_POLLSTAT:
161 		/*
162 		 * If we're not polling our PHY instance, just return.
163 		 */
164 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
165 			return (0);
166 		break;
167 
168 	case MII_MEDIACHG:
169 		/*
170 		 * If the media indicates a different PHY instance,
171 		 * isolate ourselves.
172 		 */
173 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
174 			reg = PHY_READ(sc, MII_BMCR);
175 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
176 			return (0);
177 		}
178 
179 		/*
180 		 * If the interface is not up, don't do anything.
181 		 */
182 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
183 			break;
184 
185 		mii_phy_setmedia(sc);
186 		break;
187 
188 	case MII_TICK:
189 		/*
190 		 * If we're not currently selected, just return.
191 		 */
192 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
193 			return (0);
194 
195 		if (mii_phy_tick(sc) == EJUSTRETURN)
196 			return (0);
197 		break;
198 
199 	case MII_DOWN:
200 		mii_phy_down(sc);
201 		return (0);
202 	}
203 
204 	/* Update the media status. */
205 	mii_phy_status(sc);
206 
207 	/* Callback if something changed. */
208 	mii_phy_update(sc, cmd);
209 	return (0);
210 }
211