1 /* $NetBSD: miivar.h,v 1.46 2006/03/25 23:17:36 thorpej Exp $ */
4 * Copyright (c) 1998, 1999, 2000, 2001 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.13 2008/07/22 10:59:16 sephe 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 * A network interface driver has one of these structures in its softc.
59 * It is the interface from the network interface driver to the MII
63 struct ifmedia mii_media; /* media information */
64 struct ifnet *mii_ifp; /* pointer back to network interface */
67 * For network interfaces with multiple PHYs, a list of all
68 * PHYs is required so they can all be notified when a media
71 LIST_HEAD(mii_listhead, mii_softc) mii_phys;
75 * PHY driver fills this in with active media status.
80 typedef struct mii_data mii_data_t;
83 * Requests that can be made to the downcall.
85 #define MII_TICK 1 /* once-per-second tick */
86 #define MII_MEDIACHG 2 /* user changed media; perform the switch */
87 #define MII_POLLSTAT 3 /* user requested media status; fill it in */
90 * Each PHY driver's softc has one of these as the first member.
91 * XXX This would be better named "phy_softc", but this is the name
92 * XXX BSDI used, and we would like to have the same interface.
95 device_t mii_dev; /* generic device glue */
97 LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */
99 int mii_model; /* MII_MODEL(ma->mii_id2) */
100 int mii_rev; /* MII_REV(ma->mii_id2) */
101 int mii_phy; /* our MII address */
102 int mii_inst; /* instance for ifmedia */
105 * This function pointer is used by the MII layer to call into
106 * the PHY driver to perform a `service request'.
108 int (*mii_service)(struct mii_softc *, struct mii_data *, int);
111 * This function pointer is used by the MII layer to reset PHY
113 void (*mii_reset)(struct mii_softc *);
116 * This function pointer is used by the MII layer to get the
119 void (*mii_status)(struct mii_softc *);
121 struct mii_data *mii_pdata; /* pointer to parent's mii_data */
123 int mii_flags; /* misc. flags; see below */
124 int mii_capabilities; /* capabilities from BMSR */
125 int mii_extcapabilities; /* extended capabilities from EXTSR */
126 int mii_ticks; /* MII_TICK counter */
127 int mii_anegticks; /* ticks before retrying aneg */
129 int mii_media_active; /* last active media */
130 int mii_media_status; /* last active status */
132 typedef struct mii_softc mii_softc_t;
135 #define MIIF_INITDONE 0x0001 /* has been initialized (mii_data) */
136 #define MIIF_NOISOLATE 0x0002 /* do not isolate the PHY */
137 #define MIIF_NOLOOP 0x0004 /* no loopback capability */
138 #define MIIF_HAVEFIBER 0x0020 /* from parent: has fiber interface */
139 #define MIIF_HAVE_GTCR 0x0040 /* has 100base-T2/1000base-T CR */
140 #define MIIF_IS_1000X 0x0080 /* is a 1000BASE-X device */
141 #define MIIF_DOPAUSE 0x0100 /* advertise PAUSE capability */
142 #define MIIF_IS_HPNA 0x0200 /* is a HomePNA device */
143 #define MIIF_FORCEANEG 0x0400 /* is a HomePNA device */
145 #define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP)
148 * Used to attach a PHY to a parent.
150 struct mii_attach_args {
151 struct mii_data *mii_data; /* pointer to parent data */
152 int mii_phyno; /* MII address */
153 int mii_id1; /* PHY ID register 1 */
154 int mii_id2; /* PHY ID register 2 */
155 int mii_capmask; /* capability mask from BMSR */
156 int mii_flags; /* inherited by mii_softc->mii_flags */
158 typedef struct mii_attach_args mii_attach_args_t;
161 * Used to match a PHY
164 uint32_t mpd_oui; /* PHY's oui */
165 uint32_t mpd_model; /* PHY's model */
166 const char *mpd_name; /* PHY's name */
167 void *mpd_priv; /* PHY's private data */
170 #define MII_PHYDESC_NULL \
177 #define MII_PHYDESC(oui, model) \
179 .mpd_oui = MII_OUI_##oui, \
180 .mpd_model = MII_MODEL_##oui##_##model, \
181 .mpd_name = MII_STR_##oui##_##model, \
184 #define MII_PHYDESC_ARG(oui, model, arg) \
186 .mpd_oui = MII_OUI_##oui, \
187 .mpd_model = MII_MODEL_##oui##_##model, \
188 .mpd_name = MII_STR_##oui##_##model, \
194 #define PHY_READ(p, r) \
195 MIIBUS_READREG((p)->mii_dev, (p)->mii_phy, (r))
197 #define PHY_WRITE(p, r, v) \
198 MIIBUS_WRITEREG((p)->mii_dev, (p)->mii_phy, (r), (v))
201 * An array of these structures map MII media types to BMCR/ANAR settings.
204 int mm_bmcr; /* BMCR settings for this media */
205 int mm_anar; /* ANAR settings for this media */
206 int mm_gtcr; /* 100base-T2 or 1000base-T CR */
209 #define MII_MEDIA_NONE 0
210 #define MII_MEDIA_10_T 1
211 #define MII_MEDIA_10_T_FDX 2
212 #define MII_MEDIA_100_T4 3
213 #define MII_MEDIA_100_TX 4
214 #define MII_MEDIA_100_TX_FDX 5
215 #define MII_MEDIA_1000_X 6
216 #define MII_MEDIA_1000_X_FDX 7
217 #define MII_MEDIA_1000_T 8
218 #define MII_MEDIA_1000_T_FDX 9
219 #define MII_NMEDIA 10
221 extern const struct mii_media mii_media_table[MII_NMEDIA];
223 #define MII_ANEGTICKS 5
224 #define MII_ANEGTICKS_GIGE 10
226 extern devclass_t miibus_devclass;
227 extern driver_t miibus_driver;
229 int miibus_probe(device_t);
230 int miibus_attach(device_t);
231 int miibus_detach(device_t);
233 int mii_mediachg(struct mii_data *);
234 void mii_tick(struct mii_data *);
235 void mii_pollstat(struct mii_data *);
236 int mii_phy_probe(device_t, device_t *, ifm_change_cb_t, ifm_stat_cb_t);
238 void mii_phy_add_media(struct mii_softc *);
239 void mii_phy_set_media(struct mii_softc *);
240 int mii_phy_tick(struct mii_softc *);
241 void mii_phy_update(struct mii_softc *, int);
242 int mii_phy_flowstatus(struct mii_softc *);
243 const struct mii_phydesc *mii_phy_match(const struct mii_attach_args *,
244 const struct mii_phydesc *);
246 void mii_softc_init(struct mii_softc *, struct mii_attach_args *);
248 int mii_phy_auto(struct mii_softc *, int);
249 void mii_phy_reset(struct mii_softc *);
251 void ukphy_status(struct mii_softc *);
252 int ukphy_attach(device_t);
253 int ukphy_detach(device_t);
257 #endif /* _DEV_MII_MIIVAR_H_ */