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: src/sys/dev/mii/miivar.h,v 1.3.2.1 2000/12/12 19:29:14 wpaul Exp $ 40 * $DragonFly: src/sys/dev/netif/mii_layer/miivar.h,v 1.11 2005/10/31 13:08:35 sephe Exp $ 41 */ 42 43 #ifndef _DEV_MII_MIIVAR_H_ 44 #define _DEV_MII_MIIVAR_H_ 45 46 #include <sys/queue.h> 47 48 /* 49 * Media Independent Interface autoconfiguration defintions. 50 * 51 * This file exports an interface which attempts to be compatible 52 * with the BSD/OS 3.0 interface. 53 */ 54 55 struct mii_softc; 56 57 /* 58 * A network interface driver has one of these structures in its softc. 59 * It is the interface from the network interface driver to the MII 60 * layer. 61 */ 62 struct mii_data { 63 struct ifmedia mii_media; /* media information */ 64 struct ifnet *mii_ifp; /* pointer back to network interface */ 65 66 /* 67 * For network interfaces with multiple PHYs, a list of all 68 * PHYs is required so they can all be notified when a media 69 * request is made. 70 */ 71 LIST_HEAD(mii_listhead, mii_softc) mii_phys; 72 int mii_instance; 73 74 /* 75 * PHY driver fills this in with active media status. 76 */ 77 int mii_media_status; 78 int mii_media_active; 79 }; 80 typedef struct mii_data mii_data_t; 81 82 /* 83 * This call is used by the MII layer to call into the PHY driver 84 * to perform a `service request'. 85 */ 86 typedef int (*mii_downcall_t) (struct mii_softc *, struct mii_data *, int); 87 88 /* 89 * Requests that can be made to the downcall. 90 */ 91 #define MII_TICK 1 /* once-per-second tick */ 92 #define MII_MEDIACHG 2 /* user changed media; perform the switch */ 93 #define MII_POLLSTAT 3 /* user requested media status; fill it in */ 94 95 /* 96 * Each PHY driver's softc has one of these as the first member. 97 * XXX This would be better named "phy_softc", but this is the name 98 * XXX BSDI used, and we would like to have the same interface. 99 */ 100 struct mii_softc { 101 device_t mii_dev; /* generic device glue */ 102 103 LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */ 104 105 int mii_phy; /* our MII address */ 106 int mii_inst; /* instance for ifmedia */ 107 108 mii_downcall_t mii_service; /* our downcall */ 109 struct mii_data *mii_pdata; /* pointer to parent's mii_data */ 110 struct callout mii_auto_ch; /* callout handle for phy autoneg */ 111 112 int mii_flags; /* misc. flags; see below */ 113 int mii_capabilities; /* capabilities from BMSR */ 114 int mii_ticks; /* MII_TICK counter */ 115 int mii_active; /* last active media */ 116 }; 117 typedef struct mii_softc mii_softc_t; 118 119 /* mii_flags */ 120 #define MIIF_INITDONE 0x0001 /* has been initialized (mii_data) */ 121 #define MIIF_NOISOLATE 0x0002 /* do not isolate the PHY */ 122 #define MIIF_NOLOOP 0x0004 /* no loopback capability */ 123 #define MIIF_DOINGAUTO 0x0008 /* doing autonegotiation (mii_softc) */ 124 #define MIIF_AUTOTSLEEP 0x0010 /* use tsleep(), not callout() */ 125 #define MIIF_HAVEFIBER 0x0020 /* from parent: has fiber interface */ 126 #define MIIF_HAVE_GTCR 0x0040 /* has 100base-T2/1000base-T CR */ 127 #define MIIF_IS_1000X 0x0080 /* is a 1000BASE-X device */ 128 #define MIIF_DOPAUSE 0x0100 /* advertise PAUSE capability */ 129 #define MIIF_IS_HPNA 0x0200 /* is a HomePNA device */ 130 #define MIIF_FORCEANEG 0x0400 /* is a HomePNA device */ 131 132 #define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP) 133 134 /* 135 * Used to attach a PHY to a parent. 136 */ 137 struct mii_attach_args { 138 struct mii_data *mii_data; /* pointer to parent data */ 139 int mii_phyno; /* MII address */ 140 int mii_id1; /* PHY ID register 1 */ 141 int mii_id2; /* PHY ID register 2 */ 142 int mii_capmask; /* capability mask from BMSR */ 143 int mii_flags; /* inherited by mii_softc->mii_flags */ 144 }; 145 typedef struct mii_attach_args mii_attach_args_t; 146 147 #ifdef _KERNEL 148 149 #define PHY_READ(p, r) \ 150 MIIBUS_READREG((p)->mii_dev, (p)->mii_phy, (r)) 151 152 #define PHY_WRITE(p, r, v) \ 153 MIIBUS_WRITEREG((p)->mii_dev, (p)->mii_phy, (r), (v)) 154 155 extern devclass_t miibus_devclass; 156 extern driver_t miibus_driver; 157 158 int miibus_probe (device_t); 159 int miibus_attach (device_t); 160 int miibus_detach (device_t); 161 162 int mii_anar (int); 163 int mii_mediachg (struct mii_data *); 164 void mii_tick (struct mii_data *); 165 void mii_pollstat (struct mii_data *); 166 int mii_phy_probe (device_t, device_t *, 167 ifm_change_cb_t, ifm_stat_cb_t); 168 void mii_add_media (struct mii_softc *, int); 169 int mii_bmsr_media_to_anar(struct mii_softc *); 170 void mii_softc_init (struct mii_softc *, struct mii_attach_args *); 171 172 int mii_media_from_bmcr (int); 173 174 int mii_phy_auto (struct mii_softc *, int); 175 void mii_phy_auto_stop (struct mii_softc *); 176 void mii_phy_reset (struct mii_softc *); 177 178 void ukphy_status (struct mii_softc *); 179 int ukphy_attach (device_t); 180 int ukphy_detach (device_t); 181 182 #endif /* _KERNEL */ 183 184 #endif /* _DEV_MII_MIIVAR_H_ */ 185