miivar.h revision 1.26
1 /* $NetBSD: miivar.h,v 1.26 2001/05/31 18:44:48 thorpej Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 1999, 2000 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 defintions. 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) __P((struct device *, int, int)); 56 typedef void (*mii_writereg_t) __P((struct device *, int, int, int)); 57 typedef void (*mii_statchg_t) __P((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 int mii_instance; 77 78 /* 79 * PHY driver fills this in with active media status. 80 */ 81 int mii_media_status; 82 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) __P((struct mii_softc *, struct mii_data *, int)); 98 void (*pf_status) __P((struct mii_softc *)); 99 void (*pf_reset) __P((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 int mii_phy; /* our MII address */ 121 int mii_offset; /* first PHY, second PHY, etc. */ 122 int mii_inst; /* instance for ifmedia */ 123 124 /* Our PHY functions. */ 125 const struct mii_phy_funcs *mii_funcs; 126 127 struct mii_data *mii_pdata; /* pointer to parent's mii_data */ 128 129 int mii_flags; /* misc. flags; see below */ 130 int mii_capabilities; /* capabilities from BMSR */ 131 int mii_extcapabilities; /* extended capabilities */ 132 int mii_ticks; /* MII_TICK counter */ 133 int mii_anegticks; /* ticks before retrying aneg */ 134 135 struct callout mii_nway_ch; /* NWAY callout */ 136 137 int mii_media_active; /* last active media */ 138 int mii_media_status; /* last active status */ 139 }; 140 typedef struct mii_softc mii_softc_t; 141 142 /* mii_flags */ 143 #define MIIF_INITDONE 0x0001 /* has been initialized (mii_data) */ 144 #define MIIF_NOISOLATE 0x0002 /* do not isolate the PHY */ 145 #define MIIF_NOLOOP 0x0004 /* no loopback capability */ 146 #define MIIF_DOINGAUTO 0x0008 /* doing autonegotiation (mii_softc) */ 147 #define MIIF_AUTOTSLEEP 0x0010 /* use tsleep(), not callout() */ 148 #define MIIF_HAVEFIBER 0x0020 /* from parent: has fiber interface */ 149 #define MIIF_HAVE_GTCR 0x0040 /* has 100base-T2/1000base-T CR */ 150 151 /* XXX ununsed 152 #define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP) 153 */ 154 155 /* 156 * Special `locators' passed to mii_attach(). If one of these is not 157 * an `any' value, we look for *that* PHY and configure it. If both 158 * are not `any', that is an error, and mii_attach() will panic. 159 */ 160 #define MII_OFFSET_ANY -1 161 #define MII_PHY_ANY -1 162 163 /* 164 * Used to attach a PHY to a parent. 165 */ 166 struct mii_attach_args { 167 struct mii_data *mii_data; /* pointer to parent data */ 168 int mii_phyno; /* MII address */ 169 int mii_id1; /* PHY ID register 1 */ 170 int mii_id2; /* PHY ID register 2 */ 171 int mii_capmask; /* capability mask from BMSR */ 172 int mii_flags; /* flags from parent */ 173 }; 174 typedef struct mii_attach_args mii_attach_args_t; 175 176 /* 177 * An array of these structures map MII media types to BMCR/ANAR settings. 178 */ 179 struct mii_media { 180 int mm_bmcr; /* BMCR settings for this media */ 181 int mm_anar; /* ANAR settings for this media */ 182 int mm_gtcr; /* 100base-T2 or 1000base-T CR */ 183 }; 184 185 #define MII_MEDIA_NONE 0 186 #define MII_MEDIA_10_T 1 187 #define MII_MEDIA_10_T_FDX 2 188 #define MII_MEDIA_100_T4 3 189 #define MII_MEDIA_100_TX 4 190 #define MII_MEDIA_100_TX_FDX 5 191 #define MII_MEDIA_1000_X 6 192 #define MII_MEDIA_1000_X_FDX 7 193 #define MII_MEDIA_1000_T 8 194 #define MII_MEDIA_1000_T_FDX 9 195 #define MII_NMEDIA 10 196 197 #ifdef _KERNEL 198 #include "locators.h" 199 200 #define PHY_READ(p, r) \ 201 (*(p)->mii_pdata->mii_readreg)((p)->mii_dev.dv_parent, \ 202 (p)->mii_phy, (r)) 203 204 #define PHY_WRITE(p, r, v) \ 205 (*(p)->mii_pdata->mii_writereg)((p)->mii_dev.dv_parent, \ 206 (p)->mii_phy, (r), (v)) 207 208 #define PHY_SERVICE(p, d, o) \ 209 (*(p)->mii_funcs->pf_service)((p), (d), (o)) 210 211 #define PHY_STATUS(p) \ 212 (*(p)->mii_funcs->pf_status)((p)) 213 214 #define PHY_RESET(p) \ 215 (*(p)->mii_funcs->pf_reset)((p)) 216 217 void mii_attach __P((struct device *, struct mii_data *, int, int, 218 int, int)); 219 void mii_activate __P((struct mii_data *, enum devact, int, int)); 220 void mii_detach __P((struct mii_data *, int, int)); 221 222 int mii_mediachg __P((struct mii_data *)); 223 void mii_tick __P((struct mii_data *)); 224 void mii_pollstat __P((struct mii_data *)); 225 void mii_down __P((struct mii_data *)); 226 227 int mii_phy_activate __P((struct device *, enum devact)); 228 int mii_phy_detach __P((struct device *, int)); 229 230 void mii_phy_add_media __P((struct mii_softc *)); 231 void mii_phy_delete_media __P((struct mii_softc *)); 232 233 void mii_phy_setmedia __P((struct mii_softc *)); 234 int mii_phy_auto __P((struct mii_softc *, int)); 235 void mii_phy_reset __P((struct mii_softc *)); 236 void mii_phy_down __P((struct mii_softc *)); 237 int mii_phy_tick __P((struct mii_softc *)); 238 239 void mii_phy_status __P((struct mii_softc *)); 240 void mii_phy_update __P((struct mii_softc *, int)); 241 void mii_phy_statusmsg __P((struct mii_softc *)); 242 243 void ukphy_status __P((struct mii_softc *)); 244 245 int mii_oui __P((int, int)); 246 #define MII_OUI(id1, id2) mii_oui(id1, id2) 247 #define MII_MODEL(id2) (((id2) & IDR2_MODEL) >> 4) 248 #define MII_REV(id2) ((id2) & IDR2_REV) 249 250 #endif /* _KERNEL */ 251 252 #endif /* _DEV_MII_MIIVAR_H_ */ 253
Indexes created Tue Sep 30 17:09:57 GMT 2025