1 /* $NetBSD: miivar.h,v 1.48 2007/12/09 20:28:03 jmcneill 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 40 #ifndef _DEV_MII_MIIVAR_H_ 41 #define _DEV_MII_MIIVAR_H_ 42 43 #include <sys/queue.h> 44 #include <sys/callout.h> 45 46 /* 47 * Media Independent Interface datat structure definitions. 48 */ 49 50 struct mii_softc; 51 52 /* 53 * Callbacks from MII layer into network interface device driver. 54 */ 55 typedef int (*mii_readreg_t)(struct device *, int, int); 56 typedef void (*mii_writereg_t)(struct device *, int, int, int); 57 typedef void (*mii_statchg_t)(struct device *); 58 59 /* 60 * A network interface driver has one of these structures in its softc. 61 * It is the interface from the network interface driver to the MII 62 * layer. 63 */ 64 struct mii_data { 65 struct ifmedia mii_media; /* media information */ 66 struct ifnet *mii_ifp; /* pointer back to network interface */ 67 68 int mii_flags; /* misc. flags; see below */ 69 70 /* 71 * For network interfaces with multiple PHYs, a list of all 72 * PHYs is required so they can all be notified when a media 73 * request is made. 74 */ 75 LIST_HEAD(mii_listhead, mii_softc) mii_phys; 76 u_int mii_instance; 77 78 /* 79 * PHY driver fills this in with active media status. 80 */ 81 int mii_media_status; 82 u_int mii_media_active; 83 84 /* 85 * Calls from MII layer into network interface driver. 86 */ 87 mii_readreg_t mii_readreg; 88 mii_writereg_t mii_writereg; 89 mii_statchg_t mii_statchg; 90 }; 91 typedef struct mii_data mii_data_t; 92 93 /* 94 * Functions provided by the PHY to perform various functions. 95 */ 96 struct mii_phy_funcs { 97 int (*pf_service)(struct mii_softc *, struct mii_data *, int); 98 void (*pf_status)(struct mii_softc *); 99 void (*pf_reset)(struct mii_softc *); 100 }; 101 102 /* 103 * Requests that can be made to the downcall. 104 */ 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 */ 108 #define MII_DOWN 4 /* interface is down */ 109 110 /* 111 * Each PHY driver's softc has one of these as the first member. 112 * XXX This would be better named "phy_softc", but this is the name 113 * XXX BSDI used, and we would like to have the same interface. 114 */ 115 struct mii_softc { 116 struct device mii_dev; /* generic device glue */ 117 118 LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */ 119 120 u_int32_t mii_mpd_model; /* the PHY's model (MII_MODEL())*/ 121 int mii_phy; /* our MII address */ 122 int mii_offset; /* first PHY, second PHY, etc. */ 123 u_int mii_inst; /* instance for ifmedia */ 124 125 /* Our PHY functions. */ 126 const struct mii_phy_funcs *mii_funcs; 127 128 struct mii_data *mii_pdata; /* pointer to parent's mii_data */ 129 130 int mii_flags; /* misc. flags; see below */ 131 int mii_capabilities; /* capabilities from BMSR */ 132 int mii_extcapabilities; /* extended capabilities */ 133 int mii_ticks; /* MII_TICK counter */ 134 int mii_anegticks; /* ticks before retrying aneg */ 135 136 struct callout mii_nway_ch; /* NWAY callout */ 137 138 u_int mii_media_active; /* last active media */ 139 int mii_media_status; /* last active status */ 140 }; 141 typedef struct mii_softc mii_softc_t; 142 143 /* Default mii_anegticks values. */ 144 #define MII_ANEGTICKS 5 145 #define MII_ANEGTICKS_GIGE 10 146 147 /* mii_flags */ 148 #define MIIF_INITDONE 0x0001 /* has been initialized (mii_data) */ 149 #define MIIF_NOISOLATE 0x0002 /* do not isolate the PHY */ 150 #define MIIF_NOLOOP 0x0004 /* no loopback capability */ 151 #define MIIF_DOINGAUTO 0x0008 /* doing autonegotiation (mii_softc) */ 152 #define MIIF_AUTOTSLEEP 0x0010 /* use tsleep(), not callout() */ 153 #define MIIF_HAVEFIBER 0x0020 /* from parent: has fiber interface */ 154 #define MIIF_HAVE_GTCR 0x0040 /* has 100base-T2/1000base-T CR */ 155 #define MIIF_IS_1000X 0x0080 /* is a 1000BASE-X device */ 156 #define MIIF_DOPAUSE 0x0100 /* advertise PAUSE capability */ 157 #define MIIF_IS_HPNA 0x0200 /* is a HomePNA device */ 158 #define MIIF_FORCEANEG 0x0400 /* force auto-negotiation */ 159 160 #define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP) 161 162 /* 163 * Special `locators' passed to mii_attach(). If one of these is not 164 * an `any' value, we look for *that* PHY and configure it. If both 165 * are not `any', that is an error, and mii_attach() will panic. 166 */ 167 #define MII_OFFSET_ANY -1 168 #define MII_PHY_ANY -1 169 170 /* 171 * Used to attach a PHY to a parent. 172 */ 173 struct mii_attach_args { 174 struct mii_data *mii_data; /* pointer to parent data */ 175 int mii_phyno; /* MII address */ 176 u_int mii_id1; /* PHY ID register 1 */ 177 u_int mii_id2; /* PHY ID register 2 */ 178 int mii_capmask; /* capability mask from BMSR */ 179 int mii_flags; /* flags from parent */ 180 }; 181 typedef struct mii_attach_args mii_attach_args_t; 182 183 /* 184 * Used to match a PHY. 185 */ 186 struct mii_phydesc { 187 u_int32_t mpd_oui; /* the PHY's OUI */ 188 u_int32_t mpd_model; /* the PHY's model */ 189 const char *mpd_name; /* the PHY's name */ 190 }; 191 192 /* 193 * An array of these structures map MII media types to BMCR/ANAR settings. 194 */ 195 struct mii_media { 196 int mm_bmcr; /* BMCR settings for this media */ 197 int mm_anar; /* ANAR settings for this media */ 198 int mm_gtcr; /* 100base-T2 or 1000base-T CR */ 199 }; 200 201 #define MII_MEDIA_NONE 0 202 #define MII_MEDIA_10_T 1 203 #define MII_MEDIA_10_T_FDX 2 204 #define MII_MEDIA_100_T4 3 205 #define MII_MEDIA_100_TX 4 206 #define MII_MEDIA_100_TX_FDX 5 207 #define MII_MEDIA_1000_X 6 208 #define MII_MEDIA_1000_X_FDX 7 209 #define MII_MEDIA_1000_T 8 210 #define MII_MEDIA_1000_T_FDX 9 211 #define MII_NMEDIA 10 212 213 #ifdef _KERNEL 214 215 #define PHY_READ(p, r) \ 216 (*(p)->mii_pdata->mii_readreg)(device_parent(&(p)->mii_dev), \ 217 (p)->mii_phy, (r)) 218 219 #define PHY_WRITE(p, r, v) \ 220 (*(p)->mii_pdata->mii_writereg)(device_parent(&(p)->mii_dev), \ 221 (p)->mii_phy, (r), (v)) 222 223 #define PHY_SERVICE(p, d, o) \ 224 (*(p)->mii_funcs->pf_service)((p), (d), (o)) 225 226 #define PHY_STATUS(p) \ 227 (*(p)->mii_funcs->pf_status)((p)) 228 229 #define PHY_RESET(p) \ 230 (*(p)->mii_funcs->pf_reset)((p)) 231 232 void mii_attach(struct device *, struct mii_data *, int, int, 233 int, int); 234 void mii_activate(struct mii_data *, enum devact, int, int); 235 void mii_detach(struct mii_data *, int, int); 236 bool mii_phy_resume(device_t); 237 238 int mii_mediachg(struct mii_data *); 239 void mii_tick(struct mii_data *); 240 void mii_pollstat(struct mii_data *); 241 void mii_down(struct mii_data *); 242 243 int mii_phy_activate(struct device *, enum devact); 244 int mii_phy_detach(struct device *, int); 245 246 const struct mii_phydesc *mii_phy_match(const struct mii_attach_args *, 247 const struct mii_phydesc *); 248 249 void mii_phy_add_media(struct mii_softc *); 250 void mii_phy_delete_media(struct mii_softc *); 251 252 void mii_phy_setmedia(struct mii_softc *); 253 int mii_phy_auto(struct mii_softc *, int); 254 void mii_phy_reset(struct mii_softc *); 255 void mii_phy_down(struct mii_softc *); 256 int mii_phy_tick(struct mii_softc *); 257 258 void mii_phy_status(struct mii_softc *); 259 void mii_phy_update(struct mii_softc *, int); 260 261 u_int mii_phy_flowstatus(struct mii_softc *); 262 263 void ukphy_status(struct mii_softc *); 264 265 u_int mii_oui(u_int, u_int); 266 #define MII_OUI(id1, id2) mii_oui(id1, id2) 267 #define MII_MODEL(id2) (((id2) & IDR2_MODEL) >> 4) 268 #define MII_REV(id2) ((id2) & IDR2_REV) 269 270 #endif /* _KERNEL */ 271 272 #endif /* _DEV_MII_MIIVAR_H_ */ 273