xref: /freebsd/sys/dev/mii/rdcphy.c (revision 389e4940069316fe667ffa263fa7d6390d0a960f)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 
33 /*
34  * Driver for the RDC Semiconductor R6040 10/100 PHY.
35  */
36 
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
40 #include <sys/module.h>
41 #include <sys/socket.h>
42 #include <sys/bus.h>
43 
44 #include <net/if.h>
45 #include <net/if_media.h>
46 
47 #include <dev/mii/mii.h>
48 #include <dev/mii/miivar.h>
49 #include "miidevs.h"
50 
51 #include <dev/mii/rdcphyreg.h>
52 
53 #include "miibus_if.h"
54 
55 static device_probe_t	rdcphy_probe;
56 static device_attach_t	rdcphy_attach;
57 
58 struct rdcphy_softc {
59 	struct mii_softc mii_sc;
60 	int mii_link_tick;
61 #define	RDCPHY_MANNEG_TICK	3
62 };
63 
64 static device_method_t rdcphy_methods[] = {
65 	/* device interface */
66 	DEVMETHOD(device_probe,		rdcphy_probe),
67 	DEVMETHOD(device_attach,	rdcphy_attach),
68 	DEVMETHOD(device_detach,	mii_phy_detach),
69 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
70 	DEVMETHOD_END
71 };
72 
73 static devclass_t rdcphy_devclass;
74 
75 static driver_t rdcphy_driver = {
76 	"rdcphy",
77 	rdcphy_methods,
78 	sizeof(struct rdcphy_softc)
79 };
80 
81 DRIVER_MODULE(rdcphy, miibus, rdcphy_driver, rdcphy_devclass, 0, 0);
82 
83 static int	rdcphy_service(struct mii_softc *, struct mii_data *, int);
84 static void	rdcphy_status(struct mii_softc *);
85 
86 static const struct mii_phydesc rdcphys[] = {
87 	MII_PHY_DESC(RDC, R6040),
88 	MII_PHY_END
89 };
90 
91 static const struct mii_phy_funcs rdcphy_funcs = {
92 	rdcphy_service,
93 	rdcphy_status,
94 	mii_phy_reset
95 };
96 
97 static int
98 rdcphy_probe(device_t dev)
99 {
100 
101 	return (mii_phy_dev_probe(dev, rdcphys, BUS_PROBE_DEFAULT));
102 }
103 
104 static int
105 rdcphy_attach(device_t dev)
106 {
107 
108 	mii_phy_dev_attach(dev, MIIF_NOMANPAUSE, &rdcphy_funcs, 1);
109 	return (0);
110 }
111 
112 static int
113 rdcphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
114 {
115 	struct rdcphy_softc *rsc;
116 	struct ifmedia_entry *ife;
117 
118 	rsc = (struct rdcphy_softc *)sc;
119 	ife = mii->mii_media.ifm_cur;
120 
121 	switch (cmd) {
122 	case MII_POLLSTAT:
123 		break;
124 
125 	case MII_MEDIACHG:
126 		mii_phy_setmedia(sc);
127 		switch (IFM_SUBTYPE(ife->ifm_media)) {
128 		case IFM_100_TX:
129 		case IFM_10_T:
130 			/*
131 			 * Report fake lost link event to parent
132 			 * driver.  This will stop MAC of parent
133 			 * driver and make it possible to reconfigure
134 			 * MAC after completion of link establishment.
135 			 * Note, the parent MAC seems to require
136 			 * restarting MAC when underlying any PHY
137 			 * configuration was changed even if the
138 			 * resolved speed/duplex was not changed at
139 			 * all.
140 			 */
141 			mii->mii_media_status = 0;
142 			mii->mii_media_active = IFM_ETHER | IFM_NONE;
143 			rsc->mii_link_tick = RDCPHY_MANNEG_TICK;
144 			/* Immediately report link down. */
145 			mii_phy_update(sc, MII_MEDIACHG);
146 			return (0);
147 		default:
148 			break;
149 		}
150 		break;
151 
152 	case MII_TICK:
153 		if (mii_phy_tick(sc) == EJUSTRETURN)
154 			return (0);
155 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
156 			/*
157 			 * It seems the PHY hardware does not correctly
158 			 * report link status changes when manual link
159 			 * configuration is in progress.  It is also
160 			 * possible for the PHY to complete establishing
161 			 * a link within one second such that mii(4)
162 			 * did not notice the link change.  To workaround
163 			 * the issue, emulate lost link event and wait
164 			 * for 3 seconds when manual link configuration
165 			 * is in progress.  3 seconds would be long
166 			 * enough to absorb transient link flips.
167 			 */
168 			if (rsc->mii_link_tick > 0) {
169 				rsc->mii_link_tick--;
170 				return (0);
171 			}
172 		}
173 		break;
174 	}
175 
176 	/* Update the media status. */
177 	PHY_STATUS(sc);
178 
179 	/* Callback if something changed. */
180 	mii_phy_update(sc, cmd);
181 	return (0);
182 }
183 
184 static void
185 rdcphy_status(struct mii_softc *sc)
186 {
187 	struct mii_data *mii;
188 	int bmsr, bmcr, physts;
189 
190 	mii = sc->mii_pdata;
191 
192 	mii->mii_media_status = IFM_AVALID;
193 	mii->mii_media_active = IFM_ETHER;
194 
195 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
196 	physts = PHY_READ(sc, MII_RDCPHY_STATUS);
197 
198 	if ((physts & STATUS_LINK_UP) != 0)
199 		mii->mii_media_status |= IFM_ACTIVE;
200 
201 	bmcr = PHY_READ(sc, MII_BMCR);
202 	if ((bmcr & BMCR_ISO) != 0) {
203 		mii->mii_media_active |= IFM_NONE;
204 		mii->mii_media_status = 0;
205 		return;
206 	}
207 
208 	if ((bmcr & BMCR_LOOP) != 0)
209 		mii->mii_media_active |= IFM_LOOP;
210 
211 	if ((bmcr & BMCR_AUTOEN) != 0) {
212 		if ((bmsr & BMSR_ACOMP) == 0) {
213 			/* Erg, still trying, I guess... */
214 			mii->mii_media_active |= IFM_NONE;
215 			return;
216 		}
217 	}
218 
219 	switch (physts & STATUS_SPEED_MASK) {
220 	case STATUS_SPEED_100:
221 		mii->mii_media_active |= IFM_100_TX;
222 		break;
223 	case STATUS_SPEED_10:
224 		mii->mii_media_active |= IFM_10_T;
225 		break;
226 	default:
227 		mii->mii_media_active |= IFM_NONE;
228 		return;
229 	}
230 	if ((physts & STATUS_FULL_DUPLEX) != 0)
231 		mii->mii_media_active |= IFM_FDX | mii_phy_flowstatus(sc);
232 	else
233 		mii->mii_media_active |= IFM_HDX;
234 }
235