1/*	$NetBSD: exphy.c,v 1.16 1999/04/23 04:24:32 thorpej Exp $	*/
2
3/*-
4 * SPDX-License-Identifier: BSD-2-Clause-NetBSD AND BSD-2-Clause
5 *
6 * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
7 * All rights reserved.
8 *
9 * This code is derived from software contributed to The NetBSD Foundation
10 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
11 * NASA Ames Research Center, and by Frank van der Linden.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 * 1. Redistributions of source code must retain the above copyright
17 *    notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 *    notice, this list of conditions and the following disclaimer in the
20 *    documentation and/or other materials provided with the distribution.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 */
34
35/*-
36 * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
41 * 1. Redistributions of source code must retain the above copyright
42 *    notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 *    notice, this list of conditions and the following disclaimer in the
45 *    documentation and/or other materials provided with the distribution.
46 *
47 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
48 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
49 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
50 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
51 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
52 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
53 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
54 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
55 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
56 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
57 */
58
59#include <sys/cdefs.h>
60__FBSDID("$FreeBSD: releng/12.0/sys/dev/xl/xlphy.c 326255 2017-11-27 14:52:40Z pfg $");
61
62/*
63 * driver for 3Com internal PHYs
64 */
65
66#include <sys/param.h>
67#include <sys/systm.h>
68#include <sys/kernel.h>
69#include <sys/socket.h>
70#include <sys/module.h>
71#include <sys/bus.h>
72
73#include <net/if.h>
74#include <net/if_media.h>
75
76#include <dev/mii/mii.h>
77#include <dev/mii/miivar.h>
78#include "miidevs.h"
79
80#include "miibus_if.h"
81
82static int xlphy_probe(device_t);
83static int xlphy_attach(device_t);
84
85static device_method_t xlphy_methods[] = {
86	/* device interface */
87	DEVMETHOD(device_probe,		xlphy_probe),
88	DEVMETHOD(device_attach,	xlphy_attach),
89	DEVMETHOD(device_detach,	mii_phy_detach),
90	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
91	DEVMETHOD_END
92};
93
94static devclass_t xlphy_devclass;
95
96static driver_t xlphy_driver = {
97	"xlphy",
98	xlphy_methods,
99	sizeof(struct mii_softc)
100};
101
102DRIVER_MODULE(xlphy, miibus, xlphy_driver, xlphy_devclass, 0, 0);
103
104static int	xlphy_service(struct mii_softc *, struct mii_data *, int);
105static void	xlphy_reset(struct mii_softc *);
106
107/*
108 * Some 3Com internal PHYs report zero for OUI and model, others use
109 * actual values.
110 * Note that the 3Com internal PHYs having OUI 0x105a and model 0 are
111 * handled fine by ukphy(4); they can be isolated and don't require
112 * special treatment after reset.
113 */
114static const struct mii_phydesc xlphys[] = {
115	{ 0, 0, "3Com internal media interface" },
116	MII_PHY_DESC(xxBROADCOM, 3C905C),
117	MII_PHY_END
118};
119
120static const struct mii_phy_funcs xlphy_funcs = {
121	xlphy_service,
122	ukphy_status,
123	xlphy_reset
124};
125
126static int
127xlphy_probe(device_t dev)
128{
129
130	if (strcmp(device_get_name(device_get_parent(device_get_parent(dev))),
131	    "xl") == 0)
132		return (mii_phy_dev_probe(dev, xlphys, BUS_PROBE_DEFAULT));
133	return (ENXIO);
134}
135
136static int
137xlphy_attach(device_t dev)
138{
139
140	/*
141	 * The 3Com PHY can never be isolated.
142	 */
143	mii_phy_dev_attach(dev, MIIF_NOISOLATE | MIIF_NOMANPAUSE,
144	    &xlphy_funcs, 1);
145	return (0);
146}
147
148static int
149xlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
150{
151
152	switch (cmd) {
153	case MII_POLLSTAT:
154		break;
155
156	case MII_MEDIACHG:
157		mii_phy_setmedia(sc);
158		break;
159
160	case MII_TICK:
161		/*
162		 * The 3Com PHY's autonegotiation doesn't need to be
163		 * kicked; it continues in the background.
164		 */
165		break;
166	}
167
168	/* Update the media status. */
169	PHY_STATUS(sc);
170
171	/* Callback if something changed. */
172	mii_phy_update(sc, cmd);
173	return (0);
174}
175
176static void
177xlphy_reset(struct mii_softc *sc)
178{
179
180	mii_phy_reset(sc);
181
182	/*
183	 * XXX 3Com PHY doesn't set the BMCR properly after
184	 * XXX reset, which breaks autonegotiation.
185	 */
186	PHY_WRITE(sc, MII_BMCR, BMCR_S100|BMCR_AUTOEN|BMCR_FDX);
187}
188