1 /* $NetBSD: miivar.h,v 1.46 2006/03/25 23:17:36 thorpej Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 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. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 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. 26 * 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. 38 * 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 $ 41 */ 42 43 #ifndef _DEV_MII_MIIVAR_H_ 44 #define _DEV_MII_MIIVAR_H_ 45 46 #include <sys/queue.h> 47 48 /* 49 * Media Independent Interface autoconfiguration defintions. 50 * 51 * This file exports an interface which attempts to be compatible 52 * with the BSD/OS 3.0 interface. 53 */ 54 55 struct mii_softc; 56 57 /* 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 60 * layer. 61 */ 62 struct mii_data { 63 struct ifmedia mii_media; /* media information */ 64 struct ifnet *mii_ifp; /* pointer back to network interface */ 65 66 /* 67 * For network interfaces with multiple PHYs, a list of all 68 * PHYs is required so they can all be notified when a media 69 * request is made. 70 */ 71 LIST_HEAD(mii_listhead, mii_softc) mii_phys; 72 int mii_instance; 73 74 /* 75 * PHY driver fills this in with active media status. 76 */ 77 int mii_media_status; 78 int mii_media_active; 79 }; 80 typedef struct mii_data mii_data_t; 81 82 /* 83 * Requests that can be made to the downcall. 84 */ 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 */ 88 89 /* 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. 93 */ 94 struct mii_softc { 95 device_t mii_dev; /* generic device glue */ 96 97 LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */ 98 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 */ 103 104 /* 105 * This function pointer is used by the MII layer to call into 106 * the PHY driver to perform a `service request'. 107 */ 108 int (*mii_service)(struct mii_softc *, struct mii_data *, int); 109 110 /* 111 * This function pointer is used by the MII layer to reset PHY 112 */ 113 void (*mii_reset)(struct mii_softc *); 114 115 /* 116 * This function pointer is used by the MII layer to get the 117 * status of PHY 118 */ 119 void (*mii_status)(struct mii_softc *); 120 121 struct mii_data *mii_pdata; /* pointer to parent's mii_data */ 122 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 */ 128 int mii_privtag; /* MII_PRIVTAG_ */ 129 uintptr_t mii_priv; /* private data, based on mii_privtag */ 130 131 int mii_media_active; /* last active media */ 132 int mii_media_status; /* last active status */ 133 }; 134 typedef struct mii_softc mii_softc_t; 135 136 /* mii_flags */ 137 #define MIIF_INITDONE 0x0001 /* has been initialized (mii_data) */ 138 #define MIIF_NOISOLATE 0x0002 /* do not isolate the PHY */ 139 #define MIIF_NOLOOP 0x0004 /* no loopback capability */ 140 #define MIIF_HAVEFIBER 0x0020 /* from parent: has fiber interface */ 141 #define MIIF_HAVE_GTCR 0x0040 /* has 100base-T2/1000base-T CR */ 142 #define MIIF_IS_1000X 0x0080 /* is a 1000BASE-X device */ 143 #define MIIF_DOPAUSE 0x0100 /* advertise PAUSE capability */ 144 #define MIIF_IS_HPNA 0x0200 /* is a HomePNA device */ 145 #define MIIF_FORCEANEG 0x0400 /* is a HomePNA device */ 146 147 #define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP) 148 149 /* 150 * Used to attach a PHY to a parent. 151 */ 152 struct mii_attach_args { 153 struct mii_data *mii_data; /* pointer to parent data */ 154 int mii_phyno; /* MII address */ 155 int mii_id1; /* PHY ID register 1 */ 156 int mii_id2; /* PHY ID register 2 */ 157 int mii_capmask; /* capability mask from BMSR */ 158 int mii_flags; /* inherited by mii_softc->mii_flags */ 159 int mii_privtag; /* MII_PRIVTAG_ */ 160 uintptr_t mii_priv; /* private data, based on mii_privtag */ 161 }; 162 typedef struct mii_attach_args mii_attach_args_t; 163 164 /* 165 * Used to probe a PHY to a network device. 166 */ 167 struct mii_probe_args { 168 ifm_change_cb_t mii_ifmedia_upd;/* ifmedia_upd callback */ 169 ifm_stat_cb_t mii_ifmedia_sts; /* ifmedia_sts callback */ 170 u_int mii_probemask; /* PHY probe location mask */ 171 int mii_capmask; /* capability mask from BMSR */ 172 int mii_flags; /* inherited by mii_softc->mii_flags */ 173 int mii_privtag; /* MII_PRIVTAG_ */ 174 uintptr_t mii_priv; /* private data, based on mii_privtag */ 175 }; 176 177 #define MII_PROBEMASK_DEFAULT 0xffffffff /* probe at all locations */ 178 #define MII_CAPMASK_DEFAULT 0xffffffff /* all capabilities from BMSR */ 179 180 #define MII_PRIVTAG_NONE 0 /* no private data (mii_priv) */ 181 #define MII_PRIVTAG_BRGPHY 1 /* brgphy specific */ 182 183 /* 184 * Used to match a PHY 185 */ 186 struct mii_phydesc { 187 uint32_t mpd_oui; /* PHY's oui */ 188 uint32_t mpd_model; /* PHY's model */ 189 const char *mpd_name; /* PHY's name */ 190 void *mpd_priv; /* PHY's private data */ 191 }; 192 193 #define MII_PHYDESC_NULL \ 194 { \ 195 .mpd_oui = 0, \ 196 .mpd_model = 0, \ 197 .mpd_name = NULL, \ 198 .mpd_priv = NULL \ 199 } 200 #define MII_PHYDESC(oui, model) \ 201 { \ 202 .mpd_oui = MII_OUI_##oui, \ 203 .mpd_model = MII_MODEL_##oui##_##model, \ 204 .mpd_name = MII_STR_##oui##_##model, \ 205 .mpd_priv = NULL \ 206 } 207 #define MII_PHYDESC_ARG(oui, model, arg) \ 208 { \ 209 .mpd_oui = MII_OUI_##oui, \ 210 .mpd_model = MII_MODEL_##oui##_##model, \ 211 .mpd_name = MII_STR_##oui##_##model, \ 212 .mpd_priv = arg \ 213 } 214 215 #ifdef _KERNEL 216 217 #define PHY_READ(p, r) \ 218 MIIBUS_READREG((p)->mii_dev, (p)->mii_phy, (r)) 219 220 #define PHY_WRITE(p, r, v) \ 221 MIIBUS_WRITEREG((p)->mii_dev, (p)->mii_phy, (r), (v)) 222 223 /* 224 * An array of these structures map MII media types to BMCR/ANAR settings. 225 */ 226 struct mii_media { 227 int mm_bmcr; /* BMCR settings for this media */ 228 int mm_anar; /* ANAR settings for this media */ 229 int mm_gtcr; /* 100base-T2 or 1000base-T CR */ 230 }; 231 232 #define MII_MEDIA_NONE 0 233 #define MII_MEDIA_10_T 1 234 #define MII_MEDIA_10_T_FDX 2 235 #define MII_MEDIA_100_T4 3 236 #define MII_MEDIA_100_TX 4 237 #define MII_MEDIA_100_TX_FDX 5 238 #define MII_MEDIA_1000_X 6 239 #define MII_MEDIA_1000_X_FDX 7 240 #define MII_MEDIA_1000_T 8 241 #define MII_MEDIA_1000_T_FDX 9 242 #define MII_NMEDIA 10 243 244 extern const struct mii_media mii_media_table[MII_NMEDIA]; 245 246 #define MII_ANEGTICKS 5 247 #define MII_ANEGTICKS_GIGE 10 248 249 extern devclass_t miibus_devclass; 250 extern driver_t miibus_driver; 251 252 int mii_mediachg(struct mii_data *); 253 void mii_tick(struct mii_data *); 254 void mii_pollstat(struct mii_data *); 255 int mii_phy_probe(device_t, device_t *, ifm_change_cb_t, ifm_stat_cb_t); 256 int mii_probe(device_t, device_t *, const struct mii_probe_args *); 257 void mii_probe_args_init(struct mii_probe_args *, 258 ifm_change_cb_t, ifm_stat_cb_t); 259 260 void mii_phy_add_media(struct mii_softc *); 261 void mii_phy_set_media(struct mii_softc *); 262 int mii_phy_tick(struct mii_softc *); 263 void mii_phy_update(struct mii_softc *, int); 264 int mii_phy_flowstatus(struct mii_softc *); 265 const struct mii_phydesc *mii_phy_match(const struct mii_attach_args *, 266 const struct mii_phydesc *); 267 268 void mii_softc_init(struct mii_softc *, struct mii_attach_args *); 269 270 int mii_phy_auto(struct mii_softc *, int); 271 void mii_phy_reset(struct mii_softc *); 272 273 void ukphy_status(struct mii_softc *); 274 int ukphy_attach(device_t); 275 int ukphy_detach(device_t); 276 277 #endif /* _KERNEL */ 278 279 #endif /* _DEV_MII_MIIVAR_H_ */ 280