1 /* $NetBSD: miivar.h,v 1.8 1999/04/23 04:24:32 thorpej Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 1999 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 * $FreeBSD$ 40 */ 41 42 #ifndef _DEV_MII_MIIVAR_H_ 43 #define _DEV_MII_MIIVAR_H_ 44 45 #include <sys/queue.h> 46 47 /* 48 * Media Independent Interface configuration defintions. 49 */ 50 51 struct mii_softc; 52 53 /* 54 * Callbacks from MII layer into network interface device driver. 55 */ 56 typedef int (*mii_readreg_t)(struct device *, int, int); 57 typedef void (*mii_writereg_t)(struct device *, int, int, int); 58 typedef void (*mii_statchg_t)(struct device *); 59 60 /* 61 * A network interface driver has one of these structures in its softc. 62 * It is the interface from the network interface driver to the MII 63 * layer. 64 */ 65 struct mii_data { 66 struct ifmedia mii_media; /* media information */ 67 struct ifnet *mii_ifp; /* pointer back to network interface */ 68 69 /* 70 * For network interfaces with multiple PHYs, a list of all 71 * PHYs is required so they can all be notified when a media 72 * request is made. 73 */ 74 LIST_HEAD(mii_listhead, mii_softc) mii_phys; 75 int mii_instance; 76 77 /* 78 * PHY driver fills this in with active media status. 79 */ 80 int mii_media_status; 81 int mii_media_active; 82 83 /* 84 * Calls from MII layer into network interface driver. 85 */ 86 mii_readreg_t mii_readreg; 87 mii_writereg_t mii_writereg; 88 mii_statchg_t mii_statchg; 89 }; 90 typedef struct mii_data mii_data_t; 91 92 /* 93 * This call is used by the MII layer to call into the PHY driver 94 * to perform a `service request'. 95 */ 96 typedef int (*mii_downcall_t)(struct mii_softc *, struct mii_data *, int); 97 98 /* 99 * Requests that can be made to the downcall. 100 */ 101 #define MII_TICK 1 /* once-per-second tick */ 102 #define MII_MEDIACHG 2 /* user changed media; perform the switch */ 103 #define MII_POLLSTAT 3 /* user requested media status; fill it in */ 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 int mii_phy; /* our MII address */ 116 int mii_inst; /* instance for ifmedia */ 117 118 mii_downcall_t mii_service; /* our downcall */ 119 struct mii_data *mii_pdata; /* pointer to parent's mii_data */ 120 121 int mii_flags; /* misc. flags; see below */ 122 int mii_capabilities; /* capabilities from BMSR */ 123 int mii_extcapabilities; /* extended capabilities */ 124 int mii_ticks; /* MII_TICK counter */ 125 int mii_anegticks; /* ticks before retrying aneg */ 126 int mii_media_active; /* last active media */ 127 int mii_media_status; /* last active status */ 128 }; 129 typedef struct mii_softc mii_softc_t; 130 131 /* mii_flags */ 132 #define MIIF_INITDONE 0x0001 /* has been initialized (mii_data) */ 133 #define MIIF_NOISOLATE 0x0002 /* do not isolate the PHY */ 134 #define MIIF_NOLOOP 0x0004 /* no loopback capability */ 135 #define MIIF_AUTOTSLEEP 0x0010 /* use tsleep(), not callout() */ 136 #define MIIF_HAVEFIBER 0x0020 /* from parent: has fiber interface */ 137 #define MIIF_HAVE_GTCR 0x0040 /* has 100base-T2/1000base-T CR */ 138 #define MIIF_IS_1000X 0x0080 /* is a 1000BASE-X device */ 139 #define MIIF_DOPAUSE 0x0100 /* advertise PAUSE capability */ 140 #define MIIF_IS_HPNA 0x0200 /* is a HomePNA device */ 141 142 /* Default mii_anegticks values */ 143 #define MII_ANEGTICKS 5 144 #define MII_ANEGTICKS_GIGE 17 145 146 #define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP) 147 148 /* 149 * Used to attach a PHY to a parent. 150 */ 151 struct mii_attach_args { 152 struct mii_data *mii_data; /* pointer to parent data */ 153 int mii_phyno; /* MII address */ 154 int mii_id1; /* PHY ID register 1 */ 155 int mii_id2; /* PHY ID register 2 */ 156 int mii_capmask; /* capability mask from BMSR */ 157 }; 158 typedef struct mii_attach_args mii_attach_args_t; 159 160 /* 161 * Used to match a PHY. 162 */ 163 struct mii_phydesc { 164 u_int32_t mpd_oui; /* the PHY's OUI */ 165 u_int32_t mpd_model; /* the PHY's model */ 166 const char *mpd_name; /* the PHY's name */ 167 }; 168 #define MII_PHY_DESC(a, b) { MII_OUI_ ## a, MII_MODEL_ ## a ## _ ## b, \ 169 MII_STR_ ## a ## _ ## b } 170 #define MII_PHY_END { 0, 0, NULL } 171 172 /* 173 * An array of these structures map MII media types to BMCR/ANAR settings. 174 */ 175 struct mii_media { 176 int mm_bmcr; /* BMCR settings for this media */ 177 int mm_anar; /* ANAR settings for this media */ 178 int mm_gtcr; /* 100base-T2 or 1000base-T CR */ 179 }; 180 181 #define MII_MEDIA_NONE 0 182 #define MII_MEDIA_10_T 1 183 #define MII_MEDIA_10_T_FDX 2 184 #define MII_MEDIA_100_T4 3 185 #define MII_MEDIA_100_TX 4 186 #define MII_MEDIA_100_TX_FDX 5 187 #define MII_MEDIA_1000_X 6 188 #define MII_MEDIA_1000_X_FDX 7 189 #define MII_MEDIA_1000_T 8 190 #define MII_MEDIA_1000_T_FDX 9 191 #define MII_NMEDIA 10 192 193 #ifdef _KERNEL 194 195 #define PHY_READ(p, r) \ 196 MIIBUS_READREG((p)->mii_dev, (p)->mii_phy, (r)) 197 198 #define PHY_WRITE(p, r, v) \ 199 MIIBUS_WRITEREG((p)->mii_dev, (p)->mii_phy, (r), (v)) 200 201 extern devclass_t miibus_devclass; 202 extern driver_t miibus_driver; 203 204 int miibus_probe(device_t); 205 int miibus_attach(device_t); 206 int miibus_detach(device_t); 207 208 int mii_anar(int); 209 void mii_down(struct mii_data *); 210 int mii_mediachg(struct mii_data *); 211 void mii_tick(struct mii_data *); 212 void mii_pollstat(struct mii_data *); 213 int mii_phy_probe(device_t, device_t *, ifm_change_cb_t, ifm_stat_cb_t); 214 void mii_add_media(struct mii_softc *); 215 void mii_phy_add_media(struct mii_softc *); 216 217 int mii_media_from_bmcr(int); 218 219 int mii_phy_auto(struct mii_softc *); 220 int mii_phy_detach(device_t dev); 221 void mii_phy_down(struct mii_softc *); 222 void mii_phy_reset(struct mii_softc *); 223 void mii_phy_setmedia(struct mii_softc *sc); 224 void mii_phy_update(struct mii_softc *, int); 225 int mii_phy_tick(struct mii_softc *); 226 227 const struct mii_phydesc * mii_phy_match(const struct mii_attach_args *ma, 228 const struct mii_phydesc *mpd); 229 const struct mii_phydesc * mii_phy_match_gen(const struct mii_attach_args *ma, 230 const struct mii_phydesc *mpd, size_t endlen); 231 232 void ukphy_status(struct mii_softc *); 233 #endif /* _KERNEL */ 234 235 #endif /* _DEV_MII_MIIVAR_H_ */ 236