micphy.c revision 1.1.6.2 1 /* $NetBSD: micphy.c,v 1.1.6.2 2014/05/22 11:40:23 yamt 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 Micrel KSZ9021RN PHYs
59 */
60
61 #include <sys/cdefs.h>
62 __KERNEL_RCSID(0, "$NetBSD: micphy.c,v 1.1.6.2 2014/05/22 11:40:23 yamt Exp $");
63
64 #include "opt_mii.h"
65
66 #include <sys/param.h>
67 #include <sys/systm.h>
68 #include <sys/kernel.h>
69 #include <sys/device.h>
70 #include <sys/socket.h>
71 #include <sys/errno.h>
72
73 #include <net/if.h>
74 #include <net/if_media.h>
75
76 #include <dev/mii/mii.h>
77 #include <dev/mii/miivar.h>
78 #include <dev/mii/miidevs.h>
79
80 static int micphymatch(device_t, cfdata_t, void *);
81 static void micphyattach(device_t, device_t, void *);
82
83 CFATTACH_DECL3_NEW(micphy, sizeof(struct mii_softc),
84 micphymatch, micphyattach, mii_phy_detach, mii_phy_activate, NULL, NULL,
85 DVF_DETACH_SHUTDOWN);
86
87 static int micphy_service(struct mii_softc *, struct mii_data *, int);
88 static void micphy_fixup(struct mii_softc *, int, int, device_t);
89
90 static const struct mii_phy_funcs micphy_funcs = {
91 micphy_service, ukphy_status, mii_phy_reset,
92 };
93
94 static const struct mii_phydesc micphys[] = {
95 { MII_OUI_MICREL, MII_MODEL_MICREL_KSZ9021RNI,
96 MII_STR_MICREL_KSZ9021RNI },
97
98 { 0, 0,
99 NULL },
100 };
101
102 static int
103 micphymatch(device_t parent, cfdata_t match, void *aux)
104 {
105 struct mii_attach_args *ma = aux;
106
107 if (mii_phy_match(ma, micphys) != NULL)
108 return 10;
109
110 return 1;
111 }
112
113 static void
114 micphyattach(device_t parent, device_t self, void *aux)
115 {
116 struct mii_softc *sc = device_private(self);
117 struct mii_attach_args *ma = aux;
118 struct mii_data *mii = ma->mii_data;
119 int model = MII_MODEL(ma->mii_id2);
120 int rev = MII_REV(ma->mii_id2);
121 const struct mii_phydesc *mpd;
122
123 mpd = mii_phy_match(ma, micphys);
124 aprint_naive(": Media interface\n");
125 aprint_normal(": %s, rev. %d\n", mpd->mpd_name, rev);
126
127 sc->mii_dev = self;
128 sc->mii_inst = mii->mii_instance;
129 sc->mii_phy = ma->mii_phyno;
130 sc->mii_funcs = &micphy_funcs;
131 sc->mii_pdata = mii;
132 sc->mii_flags = ma->mii_flags;
133 sc->mii_anegticks = MII_ANEGTICKS;
134
135 PHY_RESET(sc);
136
137 micphy_fixup(sc, model, rev, parent);
138
139 sc->mii_capabilities =
140 PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
141 if (sc->mii_capabilities & BMSR_EXTSTAT)
142 sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
143 aprint_normal_dev(self, "");
144 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
145 (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
146 aprint_error("no media present");
147 else
148 mii_phy_add_media(sc);
149 aprint_normal("\n");
150 }
151
152 static int
153 micphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
154 {
155 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
156 int reg;
157
158 switch (cmd) {
159 case MII_POLLSTAT:
160 /*
161 * If we're not polling our PHY instance, just return.
162 */
163 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
164 return 0;
165 break;
166
167 case MII_MEDIACHG:
168 /*
169 * If the media indicates a different PHY instance,
170 * isolate ourselves.
171 */
172 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
173 reg = PHY_READ(sc, MII_BMCR);
174 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
175 return 0;
176 }
177
178 /*
179 * If the interface is not up, don't do anything.
180 */
181 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
182 break;
183
184 mii_phy_setmedia(sc);
185 break;
186
187 case MII_TICK:
188 /*
189 * If we're not currently selected, just return.
190 */
191 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
192 return 0;
193
194 if (mii_phy_tick(sc) == EJUSTRETURN)
195 return 0;
196 break;
197
198 case MII_DOWN:
199 mii_phy_down(sc);
200 return 0;
201 }
202
203 /* Update the media status. */
204 mii_phy_status(sc);
205
206 /* Callback if something changed. */
207 mii_phy_update(sc, cmd);
208 return 0;
209 }
210
211 #define XREG_CONTROL 0x0b
212 #define XREG_WRITE 0x0c
213 #define XREG_READ 0x0d
214 #define XREG_CTL_SEL_READ 0x0000
215 #define XREG_CTL_SEL_WRITE 0x8000
216
217 #define REG_RGMII_CLOCK_AND_CONTROL 0x104
218 #define REG_RGMII_RX_DATA 0x105
219
220 static void micphy_writexreg(struct mii_softc *sc, uint32_t reg, uint32_t wval)
221 {
222 int rval;
223
224 PHY_WRITE(sc, XREG_CONTROL, XREG_CTL_SEL_WRITE | reg);
225 PHY_WRITE(sc, XREG_WRITE, wval);
226 PHY_WRITE(sc, XREG_CONTROL, XREG_CTL_SEL_READ | reg);
227 rval = PHY_READ(sc, XREG_READ);
228 KDASSERT(wval == rval);
229 }
230
231 static void
232 micphy_fixup(struct mii_softc *sc, int model, int rev, device_t parent)
233 {
234 switch (model) {
235 case MII_MODEL_MICREL_KSZ9021RNI:
236 if (!device_is_a(parent, "cpsw"))
237 break;
238
239 aprint_normal_dev(sc->mii_dev, "adjusting RGMII signal timing for cpsw\n");
240
241 // RGMII RX Data Pad Skew
242 micphy_writexreg(sc, REG_RGMII_RX_DATA, 0x0000);
243
244 // RGMII Clock and Control Pad Skew
245 micphy_writexreg(sc, REG_RGMII_CLOCK_AND_CONTROL, 0x9090);
246
247 break;
248 }
249
250 return;
251 }
252