1/*-
2 * Copyright (c) 2001-2003, Shunsuke Akiyama <akiyama@FreeBSD.org>.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 */
27
28#include <sys/cdefs.h>
29__FBSDID("$FreeBSD: releng/11.0/sys/dev/usb/net/ruephy.c 257184 2013-10-26 18:40:17Z glebius $");
30
31/*
32 * driver for RealTek RTL8150 internal PHY
33 */
34
35#include <sys/param.h>
36#include <sys/systm.h>
37#include <sys/kernel.h>
38#include <sys/malloc.h>
39#include <sys/module.h>
40#include <sys/socket.h>
41#include <sys/bus.h>
42
43#include <net/if.h>
44#include <net/if_arp.h>
45#include <net/if_media.h>
46
47#include <dev/mii/mii.h>
48#include <dev/mii/miivar.h>
49#include "miidevs.h"
50
51#include <dev/usb/net/ruephyreg.h>
52
53#include "miibus_if.h"
54
55static int ruephy_probe(device_t);
56static int ruephy_attach(device_t);
57
58static device_method_t ruephy_methods[] = {
59	/* device interface */
60	DEVMETHOD(device_probe,		ruephy_probe),
61	DEVMETHOD(device_attach,	ruephy_attach),
62	DEVMETHOD(device_detach,	mii_phy_detach),
63	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
64	DEVMETHOD_END
65};
66
67static devclass_t ruephy_devclass;
68
69static driver_t ruephy_driver = {
70	.name = "ruephy",
71	.methods = ruephy_methods,
72	.size = sizeof(struct mii_softc)
73};
74
75DRIVER_MODULE(ruephy, miibus, ruephy_driver, ruephy_devclass, 0, 0);
76
77static int ruephy_service(struct mii_softc *, struct mii_data *, int);
78static void ruephy_reset(struct mii_softc *);
79static void ruephy_status(struct mii_softc *);
80
81/*
82 * The RealTek RTL8150 internal PHY doesn't have vendor/device ID
83 * registers; rue(4) fakes up a return value of all zeros.
84 */
85static const struct mii_phydesc ruephys[] = {
86	{ 0, 0, "RealTek RTL8150 internal media interface" },
87	MII_PHY_END
88};
89
90static const struct mii_phy_funcs ruephy_funcs = {
91	ruephy_service,
92	ruephy_status,
93	ruephy_reset
94};
95
96static int
97ruephy_probe(device_t dev)
98{
99
100	if (strcmp(device_get_name(device_get_parent(device_get_parent(dev))),
101	    "rue") == 0)
102		return (mii_phy_dev_probe(dev, ruephys, BUS_PROBE_DEFAULT));
103	return (ENXIO);
104}
105
106static int
107ruephy_attach(device_t dev)
108{
109
110	mii_phy_dev_attach(dev, MIIF_NOISOLATE | MIIF_NOMANPAUSE,
111	    &ruephy_funcs, 1);
112	return (0);
113}
114
115static int
116ruephy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
117{
118	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
119	int reg;
120
121	switch (cmd) {
122	case MII_POLLSTAT:
123		break;
124
125	case MII_MEDIACHG:
126		mii_phy_setmedia(sc);
127		break;
128
129	case MII_TICK:
130		/*
131		 * Only used for autonegotiation.
132		 */
133		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
134			break;
135
136		/*
137		 * Check to see if we have link.  If we do, we don't
138		 * need to restart the autonegotiation process.  Read
139		 * the MSR twice in case it's latched.
140		 */
141		reg = PHY_READ(sc, RUEPHY_MII_MSR) |
142		    PHY_READ(sc, RUEPHY_MII_MSR);
143		if (reg & RUEPHY_MSR_LINK)
144			break;
145
146		/* Only retry autonegotiation every mii_anegticks seconds. */
147		if (sc->mii_ticks <= sc->mii_anegticks)
148			break;
149
150		sc->mii_ticks = 0;
151		PHY_RESET(sc);
152		if (mii_phy_auto(sc) == EJUSTRETURN)
153			return (0);
154		break;
155	}
156
157	/* Update the media status. */
158	PHY_STATUS(sc);
159
160	/* Callback if something changed. */
161	mii_phy_update(sc, cmd);
162
163	return (0);
164}
165
166static void
167ruephy_reset(struct mii_softc *sc)
168{
169
170	mii_phy_reset(sc);
171
172	/*
173	 * XXX RealTek RTL8150 PHY doesn't set the BMCR properly after
174	 * XXX reset, which breaks autonegotiation.
175	 */
176	PHY_WRITE(sc, MII_BMCR, (BMCR_S100 | BMCR_AUTOEN | BMCR_FDX));
177}
178
179static void
180ruephy_status(struct mii_softc *phy)
181{
182	struct mii_data *mii = phy->mii_pdata;
183	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
184	int bmsr, bmcr, msr;
185
186	mii->mii_media_status = IFM_AVALID;
187	mii->mii_media_active = IFM_ETHER;
188
189	msr = PHY_READ(phy, RUEPHY_MII_MSR) | PHY_READ(phy, RUEPHY_MII_MSR);
190	if (msr & RUEPHY_MSR_LINK)
191		mii->mii_media_status |= IFM_ACTIVE;
192
193	bmcr = PHY_READ(phy, MII_BMCR);
194	if (bmcr & BMCR_ISO) {
195		mii->mii_media_active |= IFM_NONE;
196		mii->mii_media_status = 0;
197		return;
198	}
199
200	bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
201	if (bmcr & BMCR_AUTOEN) {
202		if ((bmsr & BMSR_ACOMP) == 0) {
203			/* Erg, still trying, I guess... */
204			mii->mii_media_active |= IFM_NONE;
205			return;
206		}
207
208		if (msr & RUEPHY_MSR_SPEED100)
209			mii->mii_media_active |= IFM_100_TX;
210		else
211			mii->mii_media_active |= IFM_10_T;
212
213		if (msr & RUEPHY_MSR_DUPLEX)
214			mii->mii_media_active |=
215			    IFM_FDX | mii_phy_flowstatus(phy);
216		else
217			mii->mii_media_active |= IFM_HDX;
218	} else
219		mii->mii_media_active = ife->ifm_media;
220}
221