1 /* $NetBSD: miivar.h,v 1.8 1999/04/23 04:24:32 thorpej Exp $ */
4 * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9 * NASA Ames Research Center.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the NetBSD
22 * Foundation, Inc. and its contributors.
23 * 4. Neither the name of The NetBSD Foundation nor the names of its
24 * contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
39 * $FreeBSD: src/sys/dev/mii/miivar.h,v 1.3.2.1 2000/12/12 19:29:14 wpaul Exp $
40 * $DragonFly: src/sys/dev/netif/mii_layer/miivar.h,v 1.5 2004/09/18 19:32:59 dillon Exp $
43 #ifndef _DEV_MII_MIIVAR_H_
44 #define _DEV_MII_MIIVAR_H_
46 #include <sys/queue.h>
49 * Media Independent Interface autoconfiguration defintions.
51 * This file exports an interface which attempts to be compatible
52 * with the BSD/OS 3.0 interface.
58 * Callbacks from MII layer into network interface device driver.
60 typedef int (*mii_readreg_t) (struct device *, int, int);
61 typedef void (*mii_writereg_t) (struct device *, int, int, int);
62 typedef void (*mii_statchg_t) (struct device *);
65 * A network interface driver has one of these structures in its softc.
66 * It is the interface from the network interface driver to the MII
70 struct ifmedia mii_media; /* media information */
71 struct ifnet *mii_ifp; /* pointer back to network interface */
74 * For network interfaces with multiple PHYs, a list of all
75 * PHYs is required so they can all be notified when a media
78 LIST_HEAD(mii_listhead, mii_softc) mii_phys;
82 * PHY driver fills this in with active media status.
88 * Calls from MII layer into network interface driver.
90 mii_readreg_t mii_readreg;
91 mii_writereg_t mii_writereg;
92 mii_statchg_t mii_statchg;
94 typedef struct mii_data mii_data_t;
97 * This call is used by the MII layer to call into the PHY driver
98 * to perform a `service request'.
100 typedef int (*mii_downcall_t) (struct mii_softc *, struct mii_data *, int);
103 * Requests that can be made to the downcall.
105 #define MII_TICK 1 /* once-per-second tick */
106 #define MII_MEDIACHG 2 /* user changed media; perform the switch */
107 #define MII_POLLSTAT 3 /* user requested media status; fill it in */
110 * Each PHY driver's softc has one of these as the first member.
111 * XXX This would be better named "phy_softc", but this is the name
112 * XXX BSDI used, and we would like to have the same interface.
115 device_t mii_dev; /* generic device glue */
117 LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */
119 int mii_phy; /* our MII address */
120 int mii_inst; /* instance for ifmedia */
122 mii_downcall_t mii_service; /* our downcall */
123 struct mii_data *mii_pdata; /* pointer to parent's mii_data */
124 struct callout mii_auto_ch; /* callout handle for phy autoneg */
126 int mii_flags; /* misc. flags; see below */
127 int mii_capabilities; /* capabilities from BMSR */
128 int mii_ticks; /* MII_TICK counter */
129 int mii_active; /* last active media */
131 typedef struct mii_softc mii_softc_t;
134 #define MIIF_INITDONE 0x0001 /* has been initialized (mii_data) */
135 #define MIIF_NOISOLATE 0x0002 /* do not isolate the PHY */
136 #define MIIF_NOLOOP 0x0004 /* no loopback capability */
137 #define MIIF_DOINGAUTO 0x0008 /* doing autonegotiation (mii_softc) */
138 #define MIIF_AUTOTSLEEP 0x0010 /* use tsleep(), not callout() */
139 #define MIIF_HAVEFIBER 0x0020 /* from parent: has fiber interface */
140 #define MIIF_HAVE_GTCR 0x0040 /* has 100base-T2/1000base-T CR */
141 #define MIIF_IS_1000X 0x0080 /* is a 1000BASE-X device */
142 #define MIIF_DOPAUSE 0x0100 /* advertise PAUSE capability */
143 #define MIIF_IS_HPNA 0x0200 /* is a HomePNA device */
144 #define MIIF_FORCEANEG 0x0400 /* is a HomePNA device */
146 #define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP)
149 * Used to attach a PHY to a parent.
151 struct mii_attach_args {
152 struct mii_data *mii_data; /* pointer to parent data */
153 int mii_phyno; /* MII address */
154 int mii_id1; /* PHY ID register 1 */
155 int mii_id2; /* PHY ID register 2 */
156 int mii_capmask; /* capability mask from BMSR */
158 typedef struct mii_attach_args mii_attach_args_t;
162 #define PHY_READ(p, r) \
163 MIIBUS_READREG((p)->mii_dev, (p)->mii_phy, (r))
165 #define PHY_WRITE(p, r, v) \
166 MIIBUS_WRITEREG((p)->mii_dev, (p)->mii_phy, (r), (v))
168 extern devclass_t miibus_devclass;
169 extern driver_t miibus_driver;
171 int miibus_probe (device_t);
172 int miibus_attach (device_t);
173 int miibus_detach (device_t);
176 int mii_mediachg (struct mii_data *);
177 void mii_tick (struct mii_data *);
178 void mii_pollstat (struct mii_data *);
179 int mii_phy_probe (device_t, device_t *,
180 ifm_change_cb_t, ifm_stat_cb_t);
181 void mii_add_media (struct mii_data *, int, int);
182 void mii_softc_init (struct mii_softc *);
184 int mii_media_from_bmcr (int);
186 int mii_phy_auto (struct mii_softc *, int);
187 void mii_phy_auto_stop (struct mii_softc *);
188 void mii_phy_reset (struct mii_softc *);
190 void ukphy_status (struct mii_softc *);
193 #endif /* _DEV_MII_MIIVAR_H_ */