1 /* $OpenBSD: miivar.h,v 1.38 2023/07/08 08:18:30 kettenis Exp $ */ 2 /* $NetBSD: miivar.h,v 1.17 2000/03/06 20:56:57 thorpej Exp $ */ 3 4 /*- 5 * Copyright (c) 1998, 1999, 2000 The NetBSD Foundation, Inc. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to The NetBSD Foundation 9 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility, 10 * NASA Ames Research Center. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 23 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 24 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 * POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #ifndef _DEV_MII_MIIVAR_H_ 35 #define _DEV_MII_MIIVAR_H_ 36 37 #include <sys/queue.h> 38 #include <sys/timeout.h> 39 40 /* 41 * Media Independent Interface autoconfiguration definitions. 42 * 43 * This file exports an interface which attempts to be compatible 44 * with the BSD/OS 3.0 interface. 45 */ 46 47 struct mii_softc; 48 49 /* 50 * Callbacks from MII layer into network interface device driver. 51 */ 52 typedef int (*mii_readreg_t)(struct device *, int, int); 53 typedef void (*mii_writereg_t)(struct device *, int, int, int); 54 typedef void (*mii_statchg_t)(struct device *); 55 56 /* 57 * A network interface driver has one of these structures in its softc. 58 * It is the interface from the network interface driver to the MII 59 * layer. 60 */ 61 struct mii_data { 62 struct ifmedia mii_media; /* media information */ 63 struct ifnet *mii_ifp; /* pointer back to network interface */ 64 65 int mii_flags; /* misc. flags; see below */ 66 int mii_node; /* FDT node */ 67 68 /* 69 * For network interfaces with multiple PHYs, a list of all 70 * PHYs is required so they can all be notified when a media 71 * request is made. 72 */ 73 LIST_HEAD(mii_listhead, mii_softc) mii_phys; 74 uint64_t mii_instance; 75 76 /* 77 * PHY driver fills this in with active media status. 78 */ 79 uint64_t mii_media_status; 80 uint64_t mii_media_active; 81 82 /* 83 * Calls from MII layer into network interface driver. 84 */ 85 mii_readreg_t mii_readreg; 86 mii_writereg_t mii_writereg; 87 mii_statchg_t mii_statchg; 88 }; 89 typedef struct mii_data mii_data_t; 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 struct device mii_dev; /* generic device glue */ 112 113 LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */ 114 115 int mii_phy; /* our MII address */ 116 int mii_oui; /* MII_OUI(ma->mii_id1, ma->mii_id2) */ 117 int mii_model; /* MII_MODEL(ma->mii_id2) */ 118 int mii_rev; /* MII_REV(ma->mii_id2) */ 119 int mii_offset; /* first PHY, second PHY, etc. */ 120 uint64_t mii_inst; /* instance for ifmedia */ 121 122 /* Our PHY functions. */ 123 const struct mii_phy_funcs *mii_funcs; 124 125 struct mii_data *mii_pdata; /* pointer to parent's mii_data */ 126 127 int mii_flags; /* misc. flags; see below */ 128 int mii_capabilities; /* capabilities from BMSR */ 129 int mii_extcapabilities; /* extended capabilities */ 130 int mii_ticks; /* MII_TICK counter */ 131 int mii_anegticks; /* ticks before retrying aneg */ 132 133 struct timeout mii_phy_timo; /* timeout handle */ 134 135 uint64_t mii_media_active; /* last active media */ 136 uint64_t mii_media_status; /* last active status */ 137 }; 138 typedef struct mii_softc mii_softc_t; 139 140 /* Default mii_anegticks values. */ 141 #define MII_ANEGTICKS 5 142 #define MII_ANEGTICKS_GIGE 10 143 144 /* mii_flags */ 145 #define MIIF_INITDONE 0x0001 /* has been initialized (mii_data) */ 146 #define MIIF_NOISOLATE 0x0002 /* do not isolate the PHY */ 147 #define MIIF_NOLOOP 0x0004 /* no loopback capability */ 148 #define MIIF_DOINGAUTO 0x0008 /* doing autonegotiation (mii_softc) */ 149 #define MIIF_AUTOTSLEEP 0x0010 /* use tsleep(), not timeout() */ 150 #define MIIF_HAVEFIBER 0x0020 /* from parent: has fiber interface */ 151 #define MIIF_HAVE_GTCR 0x0040 /* has 100base-T2/1000base-T CR */ 152 #define MIIF_IS_1000X 0x0080 /* is a 1000BASE-X device */ 153 #define MIIF_DOPAUSE 0x0100 /* advertise PAUSE capability */ 154 #define MIIF_IS_HPNA 0x0200 /* is a HomePNA device */ 155 #define MIIF_FORCEANEG 0x0400 /* force autonegotiation */ 156 #define MIIF_SETDELAY 0x0800 /* set internal delay */ 157 #define MIIF_RXID 0x1000 /* add Rx delay */ 158 #define MIIF_TXID 0x2000 /* add Tx delay */ 159 #define MIIF_SGMII 0x4000 /* MAC to PHY interface is SGMII */ 160 161 #define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP) 162 163 /* 164 * Special `locators' passed to mii_attach(). If one of these is not 165 * an `any' value, we look for *that* PHY and configure it. If both 166 * are not `any', that is an error, and mii_attach() will panic. 167 */ 168 #define MII_OFFSET_ANY -1 169 #define MII_PHY_ANY -1 170 171 /* 172 * Used to attach a PHY to a parent. 173 */ 174 struct mii_attach_args { 175 struct mii_data *mii_data; /* pointer to parent data */ 176 int mii_phyno; /* MII address */ 177 int mii_id1; /* PHY ID register 1 */ 178 int mii_id2; /* PHY ID register 2 */ 179 int mii_capmask; /* capability mask from BMSR */ 180 int mii_flags; /* flags from parent */ 181 }; 182 typedef struct mii_attach_args mii_attach_args_t; 183 184 /* 185 * Used to match a PHY. 186 */ 187 struct mii_phydesc { 188 u_int32_t mpd_oui; /* the PHY's OUI */ 189 u_int32_t mpd_model; /* the PHY's model */ 190 const char *mpd_name; /* the PHY's name */ 191 }; 192 193 /* 194 * An array of these structures map MII media types to BMCR/ANAR settings. 195 */ 196 struct mii_media { 197 int mm_bmcr; /* BMCR settings for this media */ 198 int mm_anar; /* ANAR settings for this media */ 199 int mm_gtcr; /* 100base-T2 or 1000base-T CR */ 200 }; 201 202 #define MII_MEDIA_NONE 0 203 #define MII_MEDIA_10_T 1 204 #define MII_MEDIA_10_T_FDX 2 205 #define MII_MEDIA_100_T4 3 206 #define MII_MEDIA_100_TX 4 207 #define MII_MEDIA_100_TX_FDX 5 208 #define MII_MEDIA_1000_X 6 209 #define MII_MEDIA_1000_X_FDX 7 210 #define MII_MEDIA_1000_T 8 211 #define MII_MEDIA_1000_T_FDX 9 212 #define MII_NMEDIA 10 213 214 #ifdef _KERNEL 215 216 #define PHY_READ(p, r) \ 217 (*(p)->mii_pdata->mii_readreg)((p)->mii_dev.dv_parent, \ 218 (p)->mii_phy, (r)) 219 220 #define PHY_WRITE(p, r, v) \ 221 (*(p)->mii_pdata->mii_writereg)((p)->mii_dev.dv_parent, \ 222 (p)->mii_phy, (r), (v)) 223 224 #define PHY_SERVICE(p, d, o) \ 225 (*(p)->mii_funcs->pf_service)((p), (d), (o)) 226 227 #define PHY_STATUS(p) \ 228 (*(p)->mii_funcs->pf_status)((p)) 229 230 #define PHY_RESET(p) \ 231 (*(p)->mii_funcs->pf_reset)((p)) 232 233 #define mii_phy_probe(x, y, z) \ 234 mii_attach((x), (y), (z), MII_PHY_ANY, MII_OFFSET_ANY, 0) 235 236 #define MII_OUI(id1, id2) (((id1) << 6) | ((id2) >> 10)) 237 #define MII_MODEL(id2) (((id2) & IDR2_MODEL) >> 4) 238 #define MII_REV(id2) ((id2) & IDR2_REV) 239 240 void mii_attach(struct device *, struct mii_data *, int, int, 241 int, int); 242 void mii_detach(struct mii_data *, int, int); 243 244 int mii_mediachg(struct mii_data *); 245 void mii_tick(struct mii_data *); 246 void mii_pollstat(struct mii_data *); 247 void mii_down(struct mii_data *); 248 int mii_anar(uint64_t); 249 250 int mii_phy_detach(struct device *, int); 251 252 const struct mii_phydesc *mii_phy_match(const struct mii_attach_args *, 253 const struct mii_phydesc *); 254 255 void mii_phy_add_media(struct mii_softc *); 256 void mii_phy_delete_media(struct mii_softc *); 257 258 void mii_phy_setmedia(struct mii_softc *); 259 int mii_phy_auto(struct mii_softc *, int); 260 void mii_phy_auto_timeout(void *); 261 void mii_phy_reset(struct mii_softc *); 262 void mii_phy_down(struct mii_softc *); 263 int mii_phy_tick(struct mii_softc *); 264 265 void mii_phy_status(struct mii_softc *); 266 void mii_phy_update(struct mii_softc *, int); 267 int mii_phy_statusmsg(struct mii_softc *); 268 269 uint64_t mii_phy_flowstatus(struct mii_softc *); 270 271 void ukphy_status(struct mii_softc *); 272 273 #endif /* _KERNEL */ 274 275 #endif /* _DEV_MII_MIIVAR_H_ */ 276