1 /* $NetBSD: miivar.h,v 1.8 1999/04/23 04:24:32 thorpej Exp $ */ 2 3 /*- 4 * SPDX-License-Identifier: BSD-2-Clause 5 * 6 * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc. 7 * All rights reserved. 8 * 9 * This code is derived from software contributed to The NetBSD Foundation 10 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility, 11 * NASA Ames Research Center. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 1. Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32 * POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35 #ifndef _DEV_MII_MIIVAR_H_ 36 #define _DEV_MII_MIIVAR_H_ 37 38 #include <sys/queue.h> 39 #include <net/if_var.h> /* XXX driver API temporary */ 40 41 #include "opt_platform.h" 42 43 #ifdef FDT 44 #include <dev/ofw/openfirm.h> 45 #include <dev/ofw/ofw_bus.h> 46 #include <dev/ofw/ofw_bus_subr.h> 47 #endif 48 49 /* 50 * Media Independent Interface data structure defintions 51 */ 52 53 struct mii_softc; 54 55 /* 56 * A network interface driver has one of these structures in its softc. 57 * It is the interface from the network interface driver to the MII 58 * layer. 59 */ 60 struct mii_data { 61 struct ifmedia mii_media; /* media information */ 62 if_t mii_ifp; /* pointer back to network interface */ 63 64 /* 65 * For network interfaces with multiple PHYs, a list of all 66 * PHYs is required so they can all be notified when a media 67 * request is made. 68 */ 69 LIST_HEAD(mii_listhead, mii_softc) mii_phys; 70 u_int mii_instance; 71 72 /* 73 * PHY driver fills this in with active media status. 74 */ 75 u_int mii_media_status; 76 u_int mii_media_active; 77 }; 78 typedef struct mii_data mii_data_t; 79 80 /* 81 * Functions provided by the PHY to perform various functions. 82 */ 83 struct mii_phy_funcs { 84 int (*pf_service)(struct mii_softc *, struct mii_data *, int); 85 void (*pf_status)(struct mii_softc *); 86 void (*pf_reset)(struct mii_softc *); 87 }; 88 89 /* 90 * Requests that can be made to the downcall. 91 */ 92 #define MII_TICK 1 /* once-per-second tick */ 93 #define MII_MEDIACHG 2 /* user changed media; perform the switch */ 94 #define MII_POLLSTAT 3 /* user requested media status; fill it in */ 95 96 /* 97 * Each PHY driver's softc has one of these as the first member. 98 * XXX This would be better named "phy_softc", but this is the name 99 * XXX BSDI used, and we would like to have the same interface. 100 */ 101 struct mii_softc { 102 device_t mii_dev; /* generic device glue */ 103 104 LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */ 105 106 uint32_t mii_mpd_oui; /* the PHY's OUI (MII_OUI())*/ 107 uint32_t mii_mpd_model; /* the PHY's model (MII_MODEL())*/ 108 uint32_t mii_mpd_rev; /* the PHY's revision (MII_REV())*/ 109 u_int mii_capmask; /* capability mask for BMSR */ 110 u_int mii_phy; /* our MII address */ 111 u_int mii_offset; /* first PHY, second PHY, etc. */ 112 u_int mii_inst; /* instance for ifmedia */ 113 114 /* Our PHY functions. */ 115 const struct mii_phy_funcs *mii_funcs; 116 117 struct mii_data *mii_pdata; /* pointer to parent's mii_data */ 118 119 u_int mii_flags; /* misc. flags; see below */ 120 u_int mii_capabilities; /* capabilities from BMSR */ 121 u_int mii_extcapabilities; /* extended capabilities */ 122 u_int mii_ticks; /* MII_TICK counter */ 123 u_int mii_anegticks; /* ticks before retrying aneg */ 124 u_int mii_media_active; /* last active media */ 125 u_int mii_media_status; /* last active status */ 126 u_int mii_maxspeed; /* Max speed supported by this PHY */ 127 }; 128 typedef struct mii_softc mii_softc_t; 129 130 /* mii_flags */ 131 #define MIIF_INITDONE 0x00000001 /* has been initialized (mii_data) */ 132 #define MIIF_NOISOLATE 0x00000002 /* do not isolate the PHY */ 133 #if 0 134 #define MIIF_NOLOOP 0x00000004 /* no loopback capability */ 135 #endif 136 #define MIIF_DOINGAUTO 0x00000008 /* doing autonegotiation (mii_softc) */ 137 #define MIIF_AUTOTSLEEP 0x00000010 /* use tsleep(), not callout() */ 138 #define MIIF_HAVEFIBER 0x00000020 /* from parent: has fiber interface */ 139 #define MIIF_HAVE_GTCR 0x00000040 /* has 100base-T2/1000base-T CR */ 140 #define MIIF_IS_1000X 0x00000080 /* is a 1000BASE-X device */ 141 #define MIIF_DOPAUSE 0x00000100 /* advertise PAUSE capability */ 142 #define MIIF_IS_HPNA 0x00000200 /* is a HomePNA device */ 143 #define MIIF_FORCEANEG 0x00000400 /* force auto-negotiation */ 144 #define MIIF_RX_DELAY 0x00000800 /* add RX delay */ 145 #define MIIF_TX_DELAY 0x00001000 /* add TX delay */ 146 #define MIIF_NOMANPAUSE 0x00100000 /* no manual PAUSE selection */ 147 #define MIIF_FORCEPAUSE 0x00200000 /* force PAUSE advertisement */ 148 #define MIIF_MACPRIV0 0x01000000 /* private to the MAC driver */ 149 #define MIIF_MACPRIV1 0x02000000 /* private to the MAC driver */ 150 #define MIIF_MACPRIV2 0x04000000 /* private to the MAC driver */ 151 #define MIIF_PHYPRIV0 0x10000000 /* private to the PHY driver */ 152 #define MIIF_PHYPRIV1 0x20000000 /* private to the PHY driver */ 153 #define MIIF_PHYPRIV2 0x40000000 /* private to the PHY driver */ 154 155 /* Default mii_anegticks values */ 156 #define MII_ANEGTICKS 5 157 #define MII_ANEGTICKS_GIGE 17 158 159 #define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP) 160 161 /* 162 * Special `locators' passed to mii_attach(). If one of these is not 163 * an `any' value, we look for *that* PHY and configure it. If both 164 * are not `any', that is an error, and mii_attach() will fail. 165 */ 166 #define MII_OFFSET_ANY -1 167 #define MII_PHY_ANY -1 168 169 /* 170 * Constants used to describe the type of attachment between MAC and PHY. 171 */ 172 enum mii_contype { 173 MII_CONTYPE_UNKNOWN, /* Must be have value 0. */ 174 175 MII_CONTYPE_MII, 176 MII_CONTYPE_GMII, 177 MII_CONTYPE_SGMII, 178 MII_CONTYPE_QSGMII, 179 MII_CONTYPE_TBI, 180 MII_CONTYPE_REVMII, /* Reverse MII */ 181 MII_CONTYPE_RMII, 182 MII_CONTYPE_RGMII, /* Delays provided by MAC or PCB */ 183 MII_CONTYPE_RGMII_ID, /* Rx and tx delays provided by PHY */ 184 MII_CONTYPE_RGMII_RXID, /* Only rx delay provided by PHY */ 185 MII_CONTYPE_RGMII_TXID, /* Only tx delay provided by PHY */ 186 MII_CONTYPE_RTBI, 187 MII_CONTYPE_SMII, 188 MII_CONTYPE_XGMII, 189 MII_CONTYPE_TRGMII, 190 MII_CONTYPE_2000BX, 191 MII_CONTYPE_2500BX, 192 MII_CONTYPE_RXAUI, 193 194 MII_CONTYPE_COUNT /* Add new types before this line. */ 195 }; 196 typedef enum mii_contype mii_contype_t; 197 198 static inline bool 199 mii_contype_is_rgmii(mii_contype_t con) 200 { 201 202 return (con >= MII_CONTYPE_RGMII && con <= MII_CONTYPE_RGMII_TXID); 203 } 204 205 /* 206 * Used to attach a PHY to a parent. 207 */ 208 struct mii_attach_args { 209 struct mii_data *mii_data; /* pointer to parent data */ 210 u_int mii_phyno; /* MII address */ 211 u_int mii_offset; /* first PHY, second PHY, etc. */ 212 uint32_t mii_id1; /* PHY ID register 1 */ 213 uint32_t mii_id2; /* PHY ID register 2 */ 214 u_int mii_capmask; /* capability mask for BMSR */ 215 #ifdef FDT 216 struct ofw_bus_devinfo obd; 217 struct resource_list rl; 218 #endif 219 220 }; 221 typedef struct mii_attach_args mii_attach_args_t; 222 223 /* 224 * Used to match a PHY. 225 */ 226 struct mii_phydesc { 227 uint32_t mpd_oui; /* the PHY's OUI */ 228 uint32_t mpd_model; /* the PHY's model */ 229 const char *mpd_name; /* the PHY's name */ 230 }; 231 #define MII_PHY_DESC(a, b) { MII_OUI_ ## a, MII_MODEL_ ## a ## _ ## b, \ 232 MII_STR_ ## a ## _ ## b } 233 #define MII_PHY_END { 0, 0, NULL } 234 235 #ifdef _KERNEL 236 237 #define PHY_READ(p, r) \ 238 MIIBUS_READREG((p)->mii_dev, (p)->mii_phy, (r)) 239 240 #define PHY_WRITE(p, r, v) \ 241 MIIBUS_WRITEREG((p)->mii_dev, (p)->mii_phy, (r), (v)) 242 243 #define PHY_SERVICE(p, d, o) \ 244 (*(p)->mii_funcs->pf_service)((p), (d), (o)) 245 246 #define PHY_STATUS(p) \ 247 (*(p)->mii_funcs->pf_status)(p) 248 249 #define PHY_RESET(p) \ 250 (*(p)->mii_funcs->pf_reset)(p) 251 252 enum miibus_device_ivars { 253 MIIBUS_IVAR_FLAGS 254 }; 255 256 /* 257 * Simplified accessors for miibus 258 */ 259 #define MIIBUS_ACCESSOR(var, ivar, type) \ 260 __BUS_ACCESSOR(miibus, var, MIIBUS, ivar, type) 261 262 MIIBUS_ACCESSOR(flags, FLAGS, u_int) 263 264 DECLARE_CLASS(miibus_driver); 265 266 #ifdef FDT 267 DECLARE_CLASS(miibus_fdt_driver); 268 #endif 269 270 271 int mii_attach(device_t, device_t *, if_t, ifm_change_cb_t, 272 ifm_stat_cb_t, int, int, int, int); 273 int mii_mediachg(struct mii_data *); 274 void mii_tick(struct mii_data *); 275 void mii_pollstat(struct mii_data *); 276 void mii_phy_add_media(struct mii_softc *); 277 278 int mii_phy_auto(struct mii_softc *); 279 int mii_phy_detach(device_t dev); 280 u_int mii_phy_flowstatus(struct mii_softc *); 281 void mii_phy_reset(struct mii_softc *); 282 void mii_phy_setmedia(struct mii_softc *sc); 283 void mii_phy_update(struct mii_softc *, int); 284 int mii_phy_tick(struct mii_softc *); 285 int mii_phy_mac_match(struct mii_softc *, const char *); 286 int mii_dev_mac_match(device_t, const char *); 287 void *mii_phy_mac_softc(struct mii_softc *); 288 void *mii_dev_mac_softc(device_t); 289 290 const struct mii_phydesc * mii_phy_match(const struct mii_attach_args *ma, 291 const struct mii_phydesc *mpd); 292 const struct mii_phydesc * mii_phy_match_gen(const struct mii_attach_args *ma, 293 const struct mii_phydesc *mpd, size_t endlen); 294 int mii_phy_dev_probe(device_t dev, const struct mii_phydesc *mpd, int mrv); 295 void mii_phy_dev_attach(device_t dev, u_int flags, 296 const struct mii_phy_funcs *mpf, int add_media); 297 298 device_attach_t miibus_attach; 299 300 void ukphy_status(struct mii_softc *); 301 302 u_int mii_oui(u_int, u_int); 303 #define MII_OUI(id1, id2) mii_oui(id1, id2) 304 #define MII_MODEL(id2) (((id2) & IDR2_MODEL) >> 4) 305 #define MII_REV(id2) ((id2) & IDR2_REV) 306 307 #endif /* _KERNEL */ 308 309 #endif /* _DEV_MII_MIIVAR_H_ */ 310