1 /*        $NetBSD: exphy.c,v 1.58 2020/03/15 23:04:50 thorpej 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 3Com internal PHYs
59  */
60 
61 #include <sys/cdefs.h>
62 __KERNEL_RCSID(0, "$NetBSD: exphy.c,v 1.58 2020/03/15 23:04:50 thorpej Exp $");
63 
64 #include <sys/param.h>
65 #include <sys/systm.h>
66 #include <sys/kernel.h>
67 #include <sys/device.h>
68 #include <sys/socket.h>
69 
70 #include <net/if.h>
71 #include <net/if_media.h>
72 
73 #include <dev/mii/mii.h>
74 #include <dev/mii/miivar.h>
75 #include <dev/mii/miidevs.h>
76 
77 static int          exphymatch(device_t, cfdata_t, void *);
78 static void         exphyattach(device_t, device_t, void *);
79 
80 CFATTACH_DECL_NEW(exphy, sizeof(struct mii_softc),
81     exphymatch, exphyattach, mii_phy_detach, mii_phy_activate);
82 
83 static int          exphy_service(struct mii_softc *, struct mii_data *, int);
84 static void         exphy_reset(struct mii_softc *);
85 
86 static const struct mii_phy_funcs exphy_funcs = {
87           exphy_service, ukphy_status, exphy_reset,
88 };
89 
90 static int
exphymatch(device_t parent,cfdata_t match,void * aux)91 exphymatch(device_t parent, cfdata_t match, void *aux)
92 {
93           struct mii_attach_args *ma = aux;
94 
95           /*
96            * Argh, 3Com PHY reports oui == 0 model == 0!
97            */
98           if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 &&
99               MII_MODEL(ma->mii_id2) != 0)
100                     return 0;
101 
102           /*
103            * Make sure the parent is an `ex'.
104            */
105           if (!device_is_a(parent, "ex"))
106                     return 0;
107 
108           return 10;
109 }
110 
111 static void
exphyattach(device_t parent,device_t self,void * aux)112 exphyattach(device_t parent, device_t self, void *aux)
113 {
114           struct mii_softc *sc = device_private(self);
115           struct mii_attach_args *ma = aux;
116           struct mii_data *mii = ma->mii_data;
117 
118           aprint_naive(": Media interface\n");
119           aprint_normal(": 3Com internal media interface\n");
120 
121           sc->mii_dev = self;
122           sc->mii_inst = mii->mii_instance;
123           sc->mii_phy = ma->mii_phyno;
124           sc->mii_funcs = &exphy_funcs;
125           sc->mii_pdata = mii;
126           sc->mii_flags = ma->mii_flags;
127 
128           /*
129            * The 3Com PHY can never be isolated, so never allow non-zero
130            * instances!
131            */
132           if (mii->mii_instance != 0) {
133                     aprint_error_dev(self,
134                         "ignoring this PHY, non-zero instance\n");
135                     return;
136           }
137           sc->mii_flags |= MIIF_NOISOLATE;
138 
139           mii_lock(mii);
140 
141           PHY_RESET(sc);
142 
143           PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
144           sc->mii_capabilities &= ma->mii_capmask;
145 
146           mii_unlock(mii);
147 
148           mii_phy_add_media(sc);
149 }
150 
151 static int
exphy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)152 exphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
153 {
154           struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
155 
156           /* We can't isolate the 3Com PHY, so it has to be the only one! */
157           if (IFM_INST(ife->ifm_media) != sc->mii_inst)
158                     panic("exphy_service: can't isolate 3Com PHY");
159 
160           KASSERT(mii_locked(mii));
161 
162           switch (cmd) {
163           case MII_POLLSTAT:
164                     break;
165 
166           case MII_MEDIACHG:
167                     /* If the interface is not up, don't do anything. */
168                     if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
169                               break;
170 
171                     mii_phy_setmedia(sc);
172                     break;
173 
174           case MII_TICK:
175                     /* Only used for autonegotiation. */
176                     if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
177                               break;
178 
179                     if (mii_phy_tick(sc) == EJUSTRETURN)
180                               return 0;
181                     break;
182 
183           case MII_DOWN:
184                     mii_phy_down(sc);
185                     return 0;
186           }
187 
188           /* Update the media status. */
189           mii_phy_status(sc);
190 
191           /* Callback if something changed. */
192           mii_phy_update(sc, cmd);
193           return 0;
194 }
195 
196 static void
exphy_reset(struct mii_softc * sc)197 exphy_reset(struct mii_softc *sc)
198 {
199 
200           KASSERT(mii_locked(sc->mii_pdata));
201 
202           mii_phy_reset(sc);
203 
204           /*
205            * XXX 3Com PHY doesn't set the BMCR properly after
206            * XXX reset, which breaks autonegotiation.
207            */
208           PHY_WRITE(sc, MII_BMCR, BMCR_S100 | BMCR_AUTOEN | BMCR_FDX);
209 }
210