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