1 /*        $NetBSD: iophy.c,v 1.43 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.
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  * Intel 82553 PHY driver
59  */
60 
61 #include <sys/cdefs.h>
62 __KERNEL_RCSID(0, "$NetBSD: iophy.c,v 1.43 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 #include <dev/mii/iophyreg.h>
78 
79 static int          iophymatch(device_t, cfdata_t, void *);
80 static void         iophyattach(device_t, device_t, void *);
81 
82 CFATTACH_DECL_NEW(iophy, sizeof(struct mii_softc),
83     iophymatch, iophyattach, mii_phy_detach, mii_phy_activate);
84 
85 static int          iophy_service(struct mii_softc *, struct mii_data *, int);
86 static void         iophy_status(struct mii_softc *);
87 
88 static const struct mii_phy_funcs iophy_funcs = {
89           iophy_service, iophy_status, mii_phy_reset,
90 };
91 
92 static const struct mii_phydesc iophys[] = {
93           MII_PHY_DESC(xxINTEL, I82553),
94           MII_PHY_DESC(yyINTEL, I82553),
95           MII_PHY_END,
96 };
97 
98 static int
iophymatch(device_t parent,cfdata_t match,void * aux)99 iophymatch(device_t parent, cfdata_t match, void *aux)
100 {
101           struct mii_attach_args *ma = aux;
102 
103           if (mii_phy_match(ma, iophys) != NULL)
104                     return 10;
105 
106           return 0;
107 }
108 
109 static void
iophyattach(device_t parent,device_t self,void * aux)110 iophyattach(device_t parent, device_t self, void *aux)
111 {
112           struct mii_softc *sc = device_private(self);
113           struct mii_attach_args *ma = aux;
114           struct mii_data *mii = ma->mii_data;
115           const struct mii_phydesc *mpd;
116 
117           mpd = mii_phy_match(ma, iophys);
118           aprint_naive(": Media interface\n");
119           aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
120 
121           sc->mii_dev = self;
122           sc->mii_inst = mii->mii_instance;
123           sc->mii_phy = ma->mii_phyno;
124           sc->mii_funcs = &iophy_funcs;
125           sc->mii_pdata = mii;
126           sc->mii_flags = ma->mii_flags;
127 
128           mii_lock(mii);
129 
130           PHY_RESET(sc);
131 
132           PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
133           sc->mii_capabilities &= ma->mii_capmask;
134 
135           mii_unlock(mii);
136 
137           mii_phy_add_media(sc);
138 }
139 
140 static int
iophy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)141 iophy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
142 {
143           struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
144           uint16_t reg;
145 
146           KASSERT(mii_locked(mii));
147 
148           switch (cmd) {
149           case MII_POLLSTAT:
150                     /* If we're not polling our PHY instance, just return. */
151                     if (IFM_INST(ife->ifm_media) != sc->mii_inst)
152                               return 0;
153                     break;
154 
155           case MII_MEDIACHG:
156                     /*
157                      * If the media indicates a different PHY instance,
158                      * isolate ourselves.
159                      */
160                     if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
161                               PHY_READ(sc, MII_BMCR, &reg);
162                               PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
163                               return 0;
164                     }
165 
166                     /* If the interface is not up, don't do anything. */
167                     if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
168                               break;
169 
170                     mii_phy_setmedia(sc);
171                     break;
172 
173           case MII_TICK:
174                     /* If we're not currently selected, just return. */
175                     if (IFM_INST(ife->ifm_media) != sc->mii_inst)
176                               return 0;
177 
178                     if (mii_phy_tick(sc) == EJUSTRETURN)
179                               return 0;
180                     break;
181 
182           case MII_DOWN:
183                     mii_phy_down(sc);
184                     return 0;
185           }
186 
187           /* Update the media status. */
188           mii_phy_status(sc);
189 
190           /* Callback if something changed. */
191           mii_phy_update(sc, cmd);
192           return 0;
193 }
194 
195 static void
iophy_status(struct mii_softc * sc)196 iophy_status(struct mii_softc *sc)
197 {
198           struct mii_data *mii = sc->mii_pdata;
199           struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
200           uint16_t bmsr, bmcr, ext0;
201 
202           KASSERT(mii_locked(mii));
203 
204           mii->mii_media_status = IFM_AVALID;
205           mii->mii_media_active = IFM_ETHER;
206 
207           PHY_READ(sc, MII_BMSR, &bmsr);
208           if (bmsr & BMSR_LINK)
209                     mii->mii_media_status |= IFM_ACTIVE;
210 
211           PHY_READ(sc, MII_BMCR, &bmcr);
212           if (bmcr & BMCR_ISO) {
213                     mii->mii_media_active |= IFM_NONE;
214                     mii->mii_media_status = 0;
215                     return;
216           }
217 
218           if (bmcr & BMCR_LOOP)
219                     mii->mii_media_active |= IFM_LOOP;
220 
221           if (bmcr & BMCR_AUTOEN) {
222                     if ((bmsr & BMSR_ACOMP) == 0) {
223                               /* Erg, still trying, I guess... */
224                               mii->mii_media_active |= IFM_NONE;
225                               return;
226                     }
227                     PHY_READ(sc, MII_IOPHY_EXT0, &ext0);
228 
229                     if (ext0 & EXT0_SPEED) {
230                               if ((bmsr & BMSR_100TXFDX) || (bmsr & BMSR_100TXHDX))
231                                         mii->mii_media_active |= IFM_100_TX;
232                               else if (bmsr & BMSR_100T4)
233                                         mii->mii_media_active |= IFM_100_T4;
234                     } else
235                               mii->mii_media_active |= IFM_10_T;
236 
237                     if (ext0 & EXT0_DUPLEX)
238                               mii->mii_media_active |= IFM_FDX;
239                     else
240                               mii->mii_media_active |= IFM_HDX;
241           } else
242                     mii->mii_media_active = ife->ifm_media;
243 }
244