xref: /netbsd-src/sys/dev/mii/rdcphy.c (revision e6c7e151de239c49d2e38720a061ed9d1fa99309)
1 /*      $NetBSD: rdcphy.c,v 1.7 2020/03/15 23:04:50 thorpej Exp $        */
2 
3 /*-
4  * Copyright (c) 2010, Pyun YongHyeon <yongari@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice unmodified, this list of conditions, and the following
12  *    disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 /* FreeBSD: src/sys/dev/mii/rdcphy.c,v 1.1 2010/12/30 23:50:25 yongari Exp */
31 
32 /*
33  * Driver for the RDC Semiconductor R6040 10/100 PHY.
34  */
35 #include <sys/cdefs.h>
36 __KERNEL_RCSID(0, "$NetBSD: rdcphy.c,v 1.7 2020/03/15 23:04:50 thorpej Exp $");
37 
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
41 #include <sys/device.h>
42 #include <sys/socket.h>
43 #include <sys/errno.h>
44 
45 #include <sys/bus.h>
46 
47 #include <net/if.h>
48 #include <net/if_media.h>
49 
50 #include <dev/mii/mii.h>
51 #include <dev/mii/miivar.h>
52 #include <dev/mii/miidevs.h>
53 
54 #include <dev/mii/rdcphyreg.h>
55 
56 struct rdcphy_softc {
57 	struct mii_softc sc_mii;
58 	int		 sc_mii_link_tick;
59 #define	RDCPHY_MANNEG_TICK	3
60 };
61 
62 static int	rdcphymatch(device_t, cfdata_t, void *);
63 static void	rdcphyattach(device_t, device_t, void *);
64 
65 CFATTACH_DECL_NEW(rdcphy, sizeof(struct rdcphy_softc),
66     rdcphymatch, rdcphyattach, mii_phy_detach, mii_phy_activate);
67 
68 
69 static int	rdcphy_service(struct mii_softc *, struct mii_data *, int);
70 static void	rdcphy_status(struct mii_softc *);
71 
72 static const struct mii_phy_funcs rdcphy_funcs = {
73 	rdcphy_service, rdcphy_status, mii_phy_reset,
74 };
75 
76 static const struct mii_phydesc rdcphys[] = {
77 	MII_PHY_DESC(xxRDC, R6040),
78 	MII_PHY_END,
79 };
80 
81 static int
82 rdcphymatch(device_t parent, cfdata_t match, void *aux)
83 {
84 	struct mii_attach_args *ma = aux;
85 
86 	if (mii_phy_match(ma, rdcphys) != NULL)
87 		return 10;
88 
89 	return 0;
90 }
91 
92 static void
93 rdcphyattach(device_t parent, device_t self, void *aux)
94 {
95 	struct rdcphy_softc *rsc = device_private(self);
96 	struct mii_softc *sc = &rsc->sc_mii;
97 	struct mii_attach_args *ma = aux;
98 	struct mii_data *mii = ma->mii_data;
99 
100 	const struct mii_phydesc *mpd;
101 
102 	mpd = mii_phy_match(ma, rdcphys);
103 	aprint_naive(": Media interface\n");
104 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
105 
106 	sc->mii_dev = self;
107 	sc->mii_inst = mii->mii_instance;
108 	sc->mii_phy = ma->mii_phyno;
109 	sc->mii_funcs = &rdcphy_funcs;
110 	sc->mii_pdata = mii;
111 	sc->mii_flags = ma->mii_flags;
112 
113 	mii_lock(mii);
114 
115 	PHY_RESET(sc);
116 
117 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
118 	sc->mii_capabilities &= ma->mii_capmask;
119 	if (sc->mii_capabilities & BMSR_EXTSTAT)
120 		PHY_READ(sc, MII_EXTSR, &sc->mii_extcapabilities);
121 
122 	mii_unlock(mii);
123 
124 	mii_phy_add_media(sc);
125 }
126 
127 static int
128 rdcphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
129 {
130 	struct rdcphy_softc *rsc = (struct rdcphy_softc *)sc;
131 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
132 
133 	KASSERT(mii_locked(mii));
134 
135 	switch (cmd) {
136 	case MII_POLLSTAT:
137 		break;
138 
139 	case MII_MEDIACHG:
140 		/* If the interface is not up, don't do anything. */
141 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
142 			break;
143 
144 		mii_phy_setmedia(sc);
145 		switch (IFM_SUBTYPE(ife->ifm_media)) {
146 		case IFM_100_TX:
147 		case IFM_10_T:
148 			/*
149 			 * Report fake lost link event to parent driver.  This
150 			 * will stop MAC of parent driver and make it possible
151 			 * to reconfigure MAC after completion of link
152 			 * establishment.
153 			 * Note, the parent MAC seems to require restarting MAC
154 			 * when underlying any PHY configuration was changed
155 			 * even if the resolved speed/duplex was not changed at
156 			 * all.
157 			 */
158 			mii->mii_media_status = 0;
159 			mii->mii_media_active = IFM_ETHER | IFM_NONE;
160 			rsc->sc_mii_link_tick = RDCPHY_MANNEG_TICK;
161 			/* Immediately report link down. */
162 			mii_phy_update(sc, MII_MEDIACHG);
163 			return 0;
164 		default:
165 			break;
166 		}
167 		break;
168 
169 	case MII_TICK:
170 		if (mii_phy_tick(sc) == EJUSTRETURN)
171 			return 0;
172 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
173 			/*
174 			 * It seems the PHY hardware does not correctly report
175 			 * link status changes when manual link configuration
176 			 * is in progress.  It is also possible for the PHY to
177 			 * complete establishing a link within one second such
178 			 * that mii(4) did not notice the link change.
179 			 * To workaround the issue, emulate lost link event and
180 			 * wait for 3 seconds when manual link configuration
181 			 * is in progress.  3 seconds would be long enough to
182 			 * absorb transient link flips.
183 			 */
184 			if (rsc->sc_mii_link_tick > 0) {
185 				rsc->sc_mii_link_tick--;
186 				return 0;
187 			}
188 		}
189 		break;
190 	}
191 
192 	/* Update the media status. */
193 	rdcphy_status(sc);
194 
195 	/* Callback if something changed. */
196 	mii_phy_update(sc, cmd);
197 	return 0;
198 }
199 
200 static void
201 rdcphy_status(struct mii_softc *sc)
202 {
203 	struct mii_data *mii = sc->mii_pdata;
204 	uint16_t bmsr, bmcr, physts;
205 
206 	KASSERT(mii_locked(mii));
207 
208 	mii->mii_media_status = IFM_AVALID;
209 	mii->mii_media_active = IFM_ETHER;
210 
211 	PHY_READ(sc, MII_BMSR, &bmsr);
212 	PHY_READ(sc, MII_BMSR, &bmsr);
213 	PHY_READ(sc, MII_RDCPHY_STATUS, &physts);
214 
215 	if ((physts & STATUS_LINK_UP) != 0)
216 		mii->mii_media_status |= IFM_ACTIVE;
217 
218 	PHY_READ(sc, MII_BMCR, &bmcr);
219 	if ((bmcr & BMCR_ISO) != 0) {
220 		mii->mii_media_active |= IFM_NONE;
221 		mii->mii_media_status = 0;
222 		return;
223 	}
224 
225 	if ((bmcr & BMCR_LOOP) != 0)
226 		mii->mii_media_active |= IFM_LOOP;
227 
228 	if ((bmcr & BMCR_AUTOEN) != 0) {
229 		if ((bmsr & BMSR_ACOMP) == 0) {
230 			/* Erg, still trying, I guess... */
231 			mii->mii_media_active |= IFM_NONE;
232 			return;
233 		}
234 	}
235 
236 	switch (physts & STATUS_SPEED_MASK) {
237 	case STATUS_SPEED_100:
238 		mii->mii_media_active |= IFM_100_TX;
239 		break;
240 	case STATUS_SPEED_10:
241 		mii->mii_media_active |= IFM_10_T;
242 		break;
243 	default:
244 		mii->mii_media_active |= IFM_NONE;
245 		return;
246 	}
247 	if ((physts & STATUS_FULL_DUPLEX) != 0)
248 		mii->mii_media_active |= IFM_FDX | mii_phy_flowstatus(sc);
249 	else
250 		mii->mii_media_active |= IFM_HDX;
251 }
252