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 #define MIIF_FORCEANEG 0x0400 /* force auto-negotiation */ 142 143 /* Default mii_anegticks values */ 144 #define MII_ANEGTICKS 5 145 #define MII_ANEGTICKS_GIGE 17 146 147 #define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP) 148 149 /* 150 * Used to attach a PHY to a parent. 151 */ 152 struct mii_attach_args { 153 struct mii_data *mii_data; /* pointer to parent data */ 154 int mii_phyno; /* MII address */ 155 int mii_id1; /* PHY ID register 1 */ 156 int mii_id2; /* PHY ID register 2 */ 157 int mii_capmask; /* capability mask from BMSR */ 158 }; 159 typedef struct mii_attach_args mii_attach_args_t; 160 161 /* 162 * Used to match a PHY. 163 */ 164 struct mii_phydesc { 165 u_int32_t mpd_oui; /* the PHY's OUI */ 166 u_int32_t mpd_model; /* the PHY's model */ 167 const char *mpd_name; /* the PHY's name */ 168 }; 169 #define MII_PHY_DESC(a, b) { MII_OUI_ ## a, MII_MODEL_ ## a ## _ ## b, \ 170 MII_STR_ ## a ## _ ## b } 171 #define MII_PHY_END { 0, 0, NULL } 172 173 /* 174 * An array of these structures map MII media types to BMCR/ANAR settings. 175 */ 176 struct mii_media { 177 int mm_bmcr; /* BMCR settings for this media */ 178 int mm_anar; /* ANAR settings for this media */ 179 int mm_gtcr; /* 100base-T2 or 1000base-T CR */ 180 }; 181 182 #define MII_MEDIA_NONE 0 183 #define MII_MEDIA_10_T 1 184 #define MII_MEDIA_10_T_FDX 2 185 #define MII_MEDIA_100_T4 3 186 #define MII_MEDIA_100_TX 4 187 #define MII_MEDIA_100_TX_FDX 5 188 #define MII_MEDIA_1000_X 6 189 #define MII_MEDIA_1000_X_FDX 7 190 #define MII_MEDIA_1000_T 8 191 #define MII_MEDIA_1000_T_FDX 9 192 #define MII_NMEDIA 10 193 194 #ifdef _KERNEL 195 196 #define PHY_READ(p, r) \ 197 MIIBUS_READREG((p)->mii_dev, (p)->mii_phy, (r)) 198 199 #define PHY_WRITE(p, r, v) \ 200 MIIBUS_WRITEREG((p)->mii_dev, (p)->mii_phy, (r), (v)) 201 202 extern devclass_t miibus_devclass; 203 extern driver_t miibus_driver; 204 205 int miibus_probe(device_t); 206 int miibus_attach(device_t); 207 int miibus_detach(device_t); 208 209 int mii_anar(int); 210 void mii_down(struct mii_data *); 211 int mii_mediachg(struct mii_data *); 212 void mii_tick(struct mii_data *); 213 void mii_pollstat(struct mii_data *); 214 int mii_phy_probe(device_t, device_t *, ifm_change_cb_t, ifm_stat_cb_t); 215 void mii_add_media(struct mii_softc *); 216 void mii_phy_add_media(struct mii_softc *); 217 218 int mii_phy_auto(struct mii_softc *); 219 int mii_phy_detach(device_t dev); 220 void mii_phy_down(struct mii_softc *); 221 void mii_phy_reset(struct mii_softc *); 222 void mii_phy_setmedia(struct mii_softc *sc); 223 void mii_phy_update(struct mii_softc *, int); 224 int mii_phy_tick(struct mii_softc *); 225 226 const struct mii_phydesc * mii_phy_match(const struct mii_attach_args *ma, 227 const struct mii_phydesc *mpd); 228 const struct mii_phydesc * mii_phy_match_gen(const struct mii_attach_args *ma, 229 const struct mii_phydesc *mpd, size_t endlen); 230 int mii_phy_dev_probe(device_t dev, const struct mii_phydesc *mpd, int mrv); 231 232 void ukphy_status(struct mii_softc *); 233 #endif /* _KERNEL */ 234 235 #endif /* _DEV_MII_MIIVAR_H_ */ 236