1/*	$NetBSD: icsphy.c,v 1.41 2006/11/16 21:24:07 christos Exp $	*/
2
3/*-
4 * SPDX-License-Identifier: BSD-2-Clause-NetBSD
5 *
6 * Copyright (c) 1998, 1999, 2000 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.
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/mii/icsphy.c 337425 2018-08-07 17:13:42Z markj $");
61
62/*
63 * driver for Integrated Circuit Systems' ICS1889-1893 ethernet 10/100 PHY
64 * datasheet from www.icst.com
65 */
66
67#include <sys/param.h>
68#include <sys/systm.h>
69#include <sys/kernel.h>
70#include <sys/module.h>
71#include <sys/socket.h>
72#include <sys/bus.h>
73
74#include <net/if.h>
75#include <net/if_media.h>
76
77#include <dev/mii/mii.h>
78#include <dev/mii/miivar.h>
79#include "miidevs.h"
80
81#include <dev/mii/icsphyreg.h>
82
83#include "miibus_if.h"
84
85static int	icsphy_probe(device_t dev);
86static int	icsphy_attach(device_t dev);
87
88static device_method_t icsphy_methods[] = {
89	/* device interface */
90	DEVMETHOD(device_probe,		icsphy_probe),
91	DEVMETHOD(device_attach,	icsphy_attach),
92	DEVMETHOD(device_detach,	mii_phy_detach),
93	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
94	DEVMETHOD_END
95};
96
97static devclass_t icsphy_devclass;
98
99static driver_t icsphy_driver = {
100	"icsphy",
101	icsphy_methods,
102	sizeof(struct mii_softc)
103};
104
105DRIVER_MODULE(icsphy, miibus, icsphy_driver, icsphy_devclass, 0, 0);
106
107static int	icsphy_service(struct mii_softc *, struct mii_data *, int);
108static void	icsphy_status(struct mii_softc *);
109static void	icsphy_reset(struct mii_softc *);
110
111static const struct mii_phydesc icsphys[] = {
112	MII_PHY_DESC(ICS, 1889),
113	MII_PHY_DESC(ICS, 1890),
114	MII_PHY_DESC(ICS, 1892),
115	MII_PHY_DESC(ICS, 1893),
116	MII_PHY_DESC(ICS, 1893C),
117	MII_PHY_END
118};
119
120static const struct mii_phy_funcs icsphy_funcs = {
121	icsphy_service,
122	icsphy_status,
123	icsphy_reset
124};
125
126static int
127icsphy_probe(device_t dev)
128{
129
130	return (mii_phy_dev_probe(dev, icsphys, BUS_PROBE_DEFAULT));
131}
132
133static int
134icsphy_attach(device_t dev)
135{
136
137	mii_phy_dev_attach(dev, MIIF_NOISOLATE | MIIF_NOMANPAUSE,
138	    &icsphy_funcs, 1);
139	return (0);
140}
141
142static int
143icsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
144{
145
146	switch (cmd) {
147	case MII_POLLSTAT:
148		break;
149
150	case MII_MEDIACHG:
151		mii_phy_setmedia(sc);
152		break;
153
154	case MII_TICK:
155		if (mii_phy_tick(sc) == EJUSTRETURN)
156			return (0);
157		break;
158	}
159
160	/* Update the media status. */
161	PHY_STATUS(sc);
162
163	/* Callback if something changed. */
164	mii_phy_update(sc, cmd);
165	return (0);
166}
167
168static void
169icsphy_status(struct mii_softc *sc)
170{
171	struct mii_data *mii = sc->mii_pdata;
172	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
173	int bmcr, qpr;
174
175	mii->mii_media_status = IFM_AVALID;
176	mii->mii_media_active = IFM_ETHER;
177
178	/*
179	 * Don't get link from the BMSR.  It's available in the QPR,
180	 * and we have to read it twice to unlatch it anyhow.  This
181	 * gives us fewer register reads.
182	 */
183	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* unlatch */
184	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* real value */
185
186	if (qpr & QPR_LINK)
187		mii->mii_media_status |= IFM_ACTIVE;
188
189	bmcr = PHY_READ(sc, MII_BMCR);
190	if (bmcr & BMCR_ISO) {
191		mii->mii_media_active |= IFM_NONE;
192		mii->mii_media_status = 0;
193		return;
194	}
195
196	if (bmcr & BMCR_LOOP)
197		mii->mii_media_active |= IFM_LOOP;
198
199	if (bmcr & BMCR_AUTOEN) {
200		if ((qpr & QPR_ACOMP) == 0) {
201			/* Erg, still trying, I guess... */
202			mii->mii_media_active |= IFM_NONE;
203			return;
204		}
205		if (qpr & QPR_SPEED)
206			mii->mii_media_active |= IFM_100_TX;
207		else
208			mii->mii_media_active |= IFM_10_T;
209		if (qpr & QPR_FDX)
210			mii->mii_media_active |=
211			    IFM_FDX | mii_phy_flowstatus(sc);
212		else
213			mii->mii_media_active |= IFM_HDX;
214	} else
215		mii->mii_media_active = ife->ifm_media;
216}
217
218static void
219icsphy_reset(struct mii_softc *sc)
220{
221
222	mii_phy_reset(sc);
223	/* set powerdown feature */
224	switch (sc->mii_mpd_model) {
225		case MII_MODEL_ICS_1890:
226		case MII_MODEL_ICS_1893:
227			PHY_WRITE(sc, MII_ICSPHY_ECR2, ECR2_100AUTOPWRDN);
228			break;
229		case MII_MODEL_ICS_1892:
230			PHY_WRITE(sc, MII_ICSPHY_ECR2,
231			    ECR2_10AUTOPWRDN|ECR2_100AUTOPWRDN);
232			break;
233		default:
234			/* 1889 have no ECR2 */
235			break;
236	}
237	/*
238	 * There is no description that the reset do auto-negotiation in the
239	 * data sheet.
240	 */
241	PHY_WRITE(sc, MII_BMCR, BMCR_S100|BMCR_STARTNEG|BMCR_FDX);
242}
243