xref: /freebsd/sys/dev/mii/tdkphy.c (revision a03411e84728e9b267056fd31c7d1d9d1dc1b01e)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2000,2001 Jonathan Chen.
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, this list of conditions, and the following disclaimer,
12  *    without modification, immediately at the beginning of the file.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
22  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #include <sys/cdefs.h>
32 /*
33  * Driver for the TDK 78Q2120 MII
34  *
35  * References:
36  *   Datasheet for the 78Q2120 - http://www.tsc.tdk.com/lan/78q2120.pdf
37  *   Most of this code stolen from ukphy.c
38  */
39 
40 /*
41  * The TDK 78Q2120 is found on some Xircom X3201 based CardBus cards,
42  * also spotted on some 3C575 cards.  It's just like any other normal
43  * phy, except it does auto negotiation in a different way.
44  */
45 
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/kernel.h>
49 #include <sys/socket.h>
50 #include <sys/errno.h>
51 #include <sys/module.h>
52 #include <sys/bus.h>
53 
54 #include <net/if.h>
55 #include <net/if_media.h>
56 
57 #include <dev/mii/mii.h>
58 #include <dev/mii/miivar.h>
59 #include "miidevs.h"
60 
61 #include <dev/mii/tdkphyreg.h>
62 
63 #include "miibus_if.h"
64 
65 static int tdkphy_probe(device_t);
66 static int tdkphy_attach(device_t);
67 
68 static device_method_t tdkphy_methods[] = {
69 	/* device interface */
70 	DEVMETHOD(device_probe,		tdkphy_probe),
71 	DEVMETHOD(device_attach,	tdkphy_attach),
72 	DEVMETHOD(device_detach,	mii_phy_detach),
73 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
74 	DEVMETHOD_END
75 };
76 
77 static driver_t tdkphy_driver = {
78 	"tdkphy",
79 	tdkphy_methods,
80 	sizeof(struct mii_softc)
81 };
82 
83 DRIVER_MODULE(tdkphy, miibus, tdkphy_driver, 0, 0);
84 
85 static int tdkphy_service(struct mii_softc *, struct mii_data *, int);
86 static void tdkphy_status(struct mii_softc *);
87 
88 static const struct mii_phydesc tdkphys[] = {
89 	MII_PHY_DESC(xxTSC, 78Q2120),
90 	MII_PHY_END
91 };
92 
93 static const struct mii_phy_funcs tdkphy_funcs = {
94 	tdkphy_service,
95 	tdkphy_status,
96 	mii_phy_reset
97 };
98 
99 static int
100 tdkphy_probe(device_t dev)
101 {
102 
103 	return (mii_phy_dev_probe(dev, tdkphys, BUS_PROBE_DEFAULT));
104 }
105 
106 static int
107 tdkphy_attach(device_t dev)
108 {
109 
110 	mii_phy_dev_attach(dev, MIIF_NOMANPAUSE, &tdkphy_funcs, 1);
111 	return (0);
112 }
113 
114 static int
115 tdkphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
116 {
117 
118 	switch (cmd) {
119 	case MII_POLLSTAT:
120 		break;
121 
122 	case MII_MEDIACHG:
123 		mii_phy_setmedia(sc);
124 		break;
125 
126 	case MII_TICK:
127 		if (mii_phy_tick(sc) == EJUSTRETURN)
128 			return (0);
129 		break;
130 	}
131 
132 	/* Update the media status. */
133 	PHY_STATUS(sc);
134 	if (sc->mii_pdata->mii_media_active & IFM_FDX)
135 		PHY_WRITE(sc, MII_BMCR, PHY_READ(sc, MII_BMCR) | BMCR_FDX);
136 	else
137 		PHY_WRITE(sc, MII_BMCR, PHY_READ(sc, MII_BMCR) & ~BMCR_FDX);
138 
139 	/* Callback if something changed. */
140 	mii_phy_update(sc, cmd);
141 	return (0);
142 }
143 
144 static void
145 tdkphy_status(struct mii_softc *phy)
146 {
147 	struct mii_data *mii = phy->mii_pdata;
148 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
149 	int bmsr, bmcr, anlpar, diag;
150 
151 	mii->mii_media_status = IFM_AVALID;
152 	mii->mii_media_active = IFM_ETHER;
153 
154 	bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
155 	if (bmsr & BMSR_LINK)
156 		mii->mii_media_status |= IFM_ACTIVE;
157 
158 	bmcr = PHY_READ(phy, MII_BMCR);
159 	if (bmcr & BMCR_ISO) {
160 		mii->mii_media_active |= IFM_NONE;
161 		mii->mii_media_status = 0;
162 		return;
163 	}
164 
165 	if (bmcr & BMCR_LOOP)
166 		mii->mii_media_active |= IFM_LOOP;
167 
168 	if (bmcr & BMCR_AUTOEN) {
169 		/*
170 		 * NWay autonegotiation takes the highest-order common
171 		 * bit of the ANAR and ANLPAR (i.e. best media advertised
172 		 * both by us and our link partner).
173 		 */
174 		if ((bmsr & BMSR_ACOMP) == 0) {
175 			/* Erg, still trying, I guess... */
176 			mii->mii_media_active |= IFM_NONE;
177 			return;
178 		}
179 
180 		anlpar = PHY_READ(phy, MII_ANAR) & PHY_READ(phy, MII_ANLPAR);
181 		/*
182 		 * ANLPAR doesn't get set on my card, but we check it anyway,
183 		 * since it is mentioned in the 78Q2120 specs.
184 		 */
185 		if (anlpar & ANLPAR_TX_FD)
186 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
187 		else if (anlpar & ANLPAR_T4)
188 			mii->mii_media_active |= IFM_100_T4|IFM_HDX;
189 		else if (anlpar & ANLPAR_TX)
190 			mii->mii_media_active |= IFM_100_TX|IFM_HDX;
191 		else if (anlpar & ANLPAR_10_FD)
192 			mii->mii_media_active |= IFM_10_T|IFM_FDX;
193 		else if (anlpar & ANLPAR_10)
194 			mii->mii_media_active |= IFM_10_T|IFM_HDX;
195 		else {
196 			/*
197 			 * ANLPAR isn't set, which leaves two possibilities:
198 			 * 1) Auto negotiation failed
199 			 * 2) Auto negotiation completed, but the card forgot
200 			 *    to set ANLPAR.
201 			 * So we check the MII_DIAG(18) register...
202 			 */
203 			diag = PHY_READ(phy, MII_DIAG);
204 			if (diag & DIAG_NEGFAIL) /* assume 10baseT if no neg */
205 				mii->mii_media_active |= IFM_10_T|IFM_HDX;
206 			else {
207 				if (diag & DIAG_DUPLEX)
208 					mii->mii_media_active |= IFM_FDX;
209 				else
210 					mii->mii_media_active |= IFM_HDX;
211 				if (diag & DIAG_RATE_100)
212 					mii->mii_media_active |= IFM_100_TX;
213 				else
214 					mii->mii_media_active |= IFM_10_T;
215 			}
216 		}
217 		if ((mii->mii_media_active & IFM_FDX) != 0)
218 			mii->mii_media_active |= mii_phy_flowstatus(phy);
219 	} else
220 		mii->mii_media_active = ife->ifm_media;
221 }
222