xref: /netbsd/sys/dev/mii/rdcphy.c (revision 6550d01e)
1 /*      $NetBSD: rdcphy.c,v 1.1 2011/01/26 18:48:12 bouyer 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.1 2011/01/26 18:48:12 bouyer 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_OUI_RDC, MII_MODEL_RDC_R6040,
78 	  MII_STR_RDC_R6040 },
79 	{ 0,                    0,
80 	  NULL },
81 };
82 
83 static int
84 rdcphymatch(device_t parent, cfdata_t match, void *aux)
85 {
86 	struct mii_attach_args *ma = aux;
87 
88 	if (mii_phy_match(ma, rdcphys) != NULL)
89 		return (10);
90 
91 	return (0);
92 }
93 
94 static void
95 rdcphyattach(device_t parent, device_t self, void *aux)
96 {
97 	struct rdcphy_softc *rsc = device_private(self);
98 	struct mii_softc *sc = &rsc->sc_mii;
99 	struct mii_attach_args *ma = aux;
100 	struct mii_data *mii = ma->mii_data;
101 
102 	const struct mii_phydesc *mpd;
103 
104 	mpd = mii_phy_match(ma, rdcphys);
105 	aprint_naive(": Media interface\n");
106 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
107 
108 	sc->mii_dev = self;
109 	sc->mii_inst = mii->mii_instance;
110 	sc->mii_phy = ma->mii_phyno;
111 	sc->mii_funcs = &rdcphy_funcs;
112 	sc->mii_pdata = mii;
113 	sc->mii_flags = ma->mii_flags;
114 	sc->mii_anegticks = MII_ANEGTICKS;
115 
116 	PHY_RESET(sc);
117 
118 	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
119 	if (sc->mii_capabilities & BMSR_EXTSTAT)
120 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
121 	aprint_normal_dev(self, "");
122 	mii_phy_add_media(sc);
123 	aprint_normal("\n");
124 
125 	if (!pmf_device_register(self, NULL, mii_phy_resume))
126 		aprint_error_dev(self, "couldn't establish power handler\n");
127 
128 }
129 
130 static int
131 rdcphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
132 {
133 	struct rdcphy_softc *rsc = (struct rdcphy_softc *)sc;
134 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
135 
136 	switch (cmd) {
137 	case MII_POLLSTAT:
138 		break;
139 
140 	case MII_MEDIACHG:
141 		/*
142 		 * If the interface is not up, don't do anything.
143 		 */
144 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
145 			break;
146 
147 		mii_phy_setmedia(sc);
148 		switch (IFM_SUBTYPE(ife->ifm_media)) {
149 		case IFM_100_TX:
150 		case IFM_10_T:
151 			/*
152 			 * Report fake lost link event to parent
153 			 * driver.  This will stop MAC of parent
154 			 * driver and make it possible to reconfigure
155 			 * MAC after completion of link establishment.
156 			 * Note, the parent MAC seems to require
157 			 * restarting MAC when underlying any PHY
158 			 * configuration was changed even if the
159 			 * resolved speed/duplex was not changed at
160 			 * all.
161 			 */
162 			mii->mii_media_status = 0;
163 			mii->mii_media_active = IFM_ETHER | IFM_NONE;
164 			rsc->sc_mii_link_tick = RDCPHY_MANNEG_TICK;
165 			/* Immediately report link down. */
166 			mii_phy_update(sc, MII_MEDIACHG);
167 			return (0);
168 		default:
169 			break;
170 		}
171 		break;
172 
173 	case MII_TICK:
174 		if (mii_phy_tick(sc) == EJUSTRETURN)
175 			return (0);
176 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
177 			/*
178 			 * It seems the PHY hardware does not correctly
179 			 * report link status changes when manual link
180 			 * configuration is in progress.  It is also
181 			 * possible for the PHY to complete establishing
182 			 * a link within one second such that mii(4)
183 			 * did not notice the link change.  To workaround
184 			 * the issue, emulate lost link event and wait
185 			 * for 3 seconds when manual link configuration
186 			 * is in progress.  3 seconds would be long
187 			 * enough to absorb transient link flips.
188 			 */
189 			if (rsc->sc_mii_link_tick > 0) {
190 				rsc->sc_mii_link_tick--;
191 				return (0);
192 			}
193 		}
194 		break;
195 	}
196 
197 	/* Update the media status. */
198 	rdcphy_status(sc);
199 
200 	/* Callback if something changed. */
201 	mii_phy_update(sc, cmd);
202 	return (0);
203 }
204 
205 static void
206 rdcphy_status(struct mii_softc *sc)
207 {
208 	struct mii_data *mii = sc->mii_pdata;
209 	int bmsr, bmcr, physts;
210 
211 	mii->mii_media_status = IFM_AVALID;
212 	mii->mii_media_active = IFM_ETHER;
213 
214 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
215 	physts = PHY_READ(sc, MII_RDCPHY_STATUS);
216 
217 	if ((physts & STATUS_LINK_UP) != 0)
218 		mii->mii_media_status |= IFM_ACTIVE;
219 
220 	bmcr = PHY_READ(sc, MII_BMCR);
221 	if ((bmcr & BMCR_ISO) != 0) {
222 		mii->mii_media_active |= IFM_NONE;
223 		mii->mii_media_status = 0;
224 		return;
225 	}
226 
227 	if ((bmcr & BMCR_LOOP) != 0)
228 		mii->mii_media_active |= IFM_LOOP;
229 
230 	if ((bmcr & BMCR_AUTOEN) != 0) {
231 		if ((bmsr & BMSR_ACOMP) == 0) {
232 			/* Erg, still trying, I guess... */
233 			mii->mii_media_active |= IFM_NONE;
234 			return;
235 		}
236 	}
237 
238 	switch (physts & STATUS_SPEED_MASK) {
239 	case STATUS_SPEED_100:
240 		mii->mii_media_active |= IFM_100_TX;
241 		break;
242 	case STATUS_SPEED_10:
243 		mii->mii_media_active |= IFM_10_T;
244 		break;
245 	default:
246 		mii->mii_media_active |= IFM_NONE;
247 		return;
248 	}
249 	if ((physts & STATUS_FULL_DUPLEX) != 0)
250 		mii->mii_media_active |= IFM_FDX | mii_phy_flowstatus(sc);
251 	else
252 		mii->mii_media_active |= IFM_HDX;
253 }
254