xref: /netbsd-src/sys/dev/mii/pnaphy.c (revision 2d8e86c2f207da6fbbd50f11b6f33765ebdfa0e9)
1 /*	$NetBSD: pnaphy.c,v 1.24 2019/03/25 09:20:46 msaitoh Exp $	*/
2 
3 /*
4  * Copyright 2001 Wasabi Systems, Inc.
5  * All rights reserved.
6  *
7  * Written by Jason R. Thorpe for Wasabi Systems, Inc.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *	This product includes software developed for the NetBSD Project by
20  *	Wasabi Systems, Inc.
21  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
22  *    or promote products derived from this software without specific prior
23  *    written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
29  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35  * POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 /*
39  * Driver for generic HomePNA 1.0 PHYs.
40  *
41  * HomePNA 1.0 PHYs are pretty simple -- they support exactly one
42  * media type, and don't do autonegotiation.
43  *
44  * HomePNA PHYs often have vendor-specific registers for tuning
45  * the network connection, but we don't deal with any of that
46  * at all.
47  */
48 
49 #include <sys/cdefs.h>
50 __KERNEL_RCSID(0, "$NetBSD: pnaphy.c,v 1.24 2019/03/25 09:20:46 msaitoh Exp $");
51 
52 #include <sys/param.h>
53 #include <sys/systm.h>
54 #include <sys/kernel.h>
55 #include <sys/device.h>
56 #include <sys/socket.h>
57 #include <sys/errno.h>
58 
59 #include <net/if.h>
60 #include <net/if_media.h>
61 
62 #include <dev/mii/mii.h>
63 #include <dev/mii/miivar.h>
64 #include <dev/mii/miidevs.h>
65 
66 static int	pnaphymatch(device_t, cfdata_t, void *);
67 static void	pnaphyattach(device_t, device_t, void *);
68 
69 CFATTACH_DECL_NEW(pnaphy, sizeof(struct mii_softc),
70     pnaphymatch, pnaphyattach, mii_phy_detach, mii_phy_activate);
71 
72 static int	pnaphy_service(struct mii_softc *, struct mii_data *, int);
73 static void	pnaphy_status(struct mii_softc *);
74 
75 static const struct mii_phy_funcs pnaphy_funcs = {
76 	pnaphy_service, pnaphy_status, mii_phy_reset,
77 };
78 
79 static const struct mii_phydesc pnaphys[] = {
80 	MII_PHY_DESC(yyAMD, 79c901home),
81 	MII_PHY_END,
82 };
83 
84 static int
85 pnaphymatch(device_t parent, cfdata_t match, void *aux)
86 {
87 	struct mii_attach_args *ma = aux;
88 
89 	if (mii_phy_match(ma, pnaphys) != NULL) {
90 		/*
91 		 * Match higher than ukphy, but lower than a specific
92 		 * driver would match.
93 		 */
94 		return 2;
95 	}
96 
97 	return 0;
98 }
99 
100 static void
101 pnaphyattach(device_t parent, device_t self, void *aux)
102 {
103 	struct mii_softc *sc = device_private(self);
104 	struct mii_attach_args *ma = aux;
105 	struct mii_data *mii = ma->mii_data;
106 	const struct mii_phydesc *mpd;
107 
108 	mpd = mii_phy_match(ma, pnaphys);
109 	aprint_naive(": Media interface\n");
110 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
111 
112 	sc->mii_dev = self;
113 	sc->mii_inst = mii->mii_instance;
114 	sc->mii_phy = ma->mii_phyno;
115 	sc->mii_funcs = &pnaphy_funcs;
116 	sc->mii_pdata = mii;
117 	sc->mii_flags = ma->mii_flags | MIIF_IS_HPNA; /* Force HomePNA */
118 	sc->mii_anegticks = MII_ANEGTICKS;
119 
120 	PHY_RESET(sc);
121 
122 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
123 	sc->mii_capabilities &= ma->mii_capmask;
124 	aprint_normal_dev(self, "");
125 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
126 		aprint_error("no media present");
127 	else
128 		mii_phy_add_media(sc);
129 	aprint_normal("\n");
130 }
131 
132 static int
133 pnaphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
134 {
135 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
136 	uint16_t reg;
137 
138 	switch (cmd) {
139 	case MII_POLLSTAT:
140 		/* If we're not polling our PHY instance, just return. */
141 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
142 			return 0;
143 		break;
144 
145 	case MII_MEDIACHG:
146 		/*
147 		 * If the media indicates a different PHY instance,
148 		 * isolate ourselves.
149 		 */
150 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
151 			PHY_READ(sc, MII_BMCR, &reg);
152 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
153 			return 0;
154 		}
155 
156 		/* If the interface is not up, don't do anything. */
157 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
158 			break;
159 
160 		mii_phy_setmedia(sc);
161 		break;
162 
163 	case MII_TICK:
164 		/* If we're not currently selected, just return. */
165 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
166 			return 0;
167 
168 		if (mii_phy_tick(sc) == EJUSTRETURN)
169 			return 0;
170 		break;
171 
172 	case MII_DOWN:
173 		mii_phy_down(sc);
174 		return 0;
175 	}
176 
177 	/* Update the media status. */
178 	mii_phy_status(sc);
179 
180 	/* Callback if something changed. */
181 	mii_phy_update(sc, cmd);
182 	return 0;
183 }
184 
185 static void
186 pnaphy_status(struct mii_softc *sc)
187 {
188 	struct mii_data *mii = sc->mii_pdata;
189 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
190 	uint16_t bmsr, bmcr;
191 
192 	mii->mii_media_status = IFM_AVALID;
193 	mii->mii_media_active = IFM_ETHER;
194 
195 	PHY_READ(sc, MII_BMSR, &bmsr);
196 	PHY_READ(sc, MII_BMSR, &bmsr);
197 
198 	if (bmsr & BMSR_LINK)
199 		mii->mii_media_status |= IFM_ACTIVE;
200 
201 	PHY_READ(sc, MII_BMCR, &bmcr);
202 	if (bmcr & BMCR_ISO) {
203 		mii->mii_media_active |= IFM_NONE;
204 		mii->mii_media_status = 0;
205 		return;
206 	}
207 
208 	if (bmcr & BMCR_LOOP)
209 		mii->mii_media_active |= IFM_LOOP;
210 
211 	/*
212 	 * On HomePNA PHYs, the current media is always the selected
213 	 * media.
214 	 *
215 	 * XXX May not be the case w/ HomePNA 2.
216 	 */
217 	mii->mii_media_active = ife->ifm_media;
218 }
219