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 autoconfiguration defintions. 49 * 50 * This file exports an interface which attempts to be compatible 51 * with the BSD/OS 3.0 interface. 52 */ 53 54 struct mii_softc; 55 56 /* 57 * Callbacks from MII layer into network interface device driver. 58 */ 59 typedef int (*mii_readreg_t) __P((struct device *, int, int)); 60 typedef void (*mii_writereg_t) __P((struct device *, int, int, int)); 61 typedef void (*mii_statchg_t) __P((struct device *)); 62 63 /* 64 * A network interface driver has one of these structures in its softc. 65 * It is the interface from the network interface driver to the MII 66 * layer. 67 */ 68 struct mii_data { 69 struct ifmedia mii_media; /* media information */ 70 struct ifnet *mii_ifp; /* pointer back to network interface */ 71 72 /* 73 * For network interfaces with multiple PHYs, a list of all 74 * PHYs is required so they can all be notified when a media 75 * request is made. 76 */ 77 LIST_HEAD(mii_listhead, mii_softc) mii_phys; 78 int mii_instance; 79 80 /* 81 * PHY driver fills this in with active media status. 82 */ 83 int mii_media_status; 84 int mii_media_active; 85 86 /* 87 * Calls from MII layer into network interface driver. 88 */ 89 mii_readreg_t mii_readreg; 90 mii_writereg_t mii_writereg; 91 mii_statchg_t mii_statchg; 92 }; 93 typedef struct mii_data mii_data_t; 94 95 /* 96 * This call is used by the MII layer to call into the PHY driver 97 * to perform a `service request'. 98 */ 99 typedef int (*mii_downcall_t) __P((struct mii_softc *, struct mii_data *, int)); 100 101 /* 102 * Requests that can be made to the downcall. 103 */ 104 #define MII_TICK 1 /* once-per-second tick */ 105 #define MII_MEDIACHG 2 /* user changed media; perform the switch */ 106 #define MII_POLLSTAT 3 /* user requested media status; fill it in */ 107 108 /* 109 * Each PHY driver's softc has one of these as the first member. 110 * XXX This would be better named "phy_softc", but this is the name 111 * XXX BSDI used, and we would like to have the same interface. 112 */ 113 struct mii_softc { 114 device_t mii_dev; /* generic device glue */ 115 116 LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */ 117 118 int mii_phy; /* our MII address */ 119 int mii_inst; /* instance for ifmedia */ 120 121 mii_downcall_t mii_service; /* our downcall */ 122 struct mii_data *mii_pdata; /* pointer to parent's mii_data */ 123 124 int mii_flags; /* misc. flags; see below */ 125 int mii_capabilities; /* capabilities from BMSR */ 126 int mii_ticks; /* MII_TICK counter */ 127 int mii_active; /* last active media */ 128 }; 129 typedef struct mii_softc mii_softc_t; 130 131 /* mii_flags */ 132 #define MIIF_NOISOLATE 0x0001 /* do not isolate the PHY */ 133 #define MIIF_DOINGAUTO 0x0002 /* doing autonegotiation */ 134 135 /* 136 * Used to attach a PHY to a parent. 137 */ 138 struct mii_attach_args { 139 struct mii_data *mii_data; /* pointer to parent data */ 140 int mii_phyno; /* MII address */ 141 int mii_id1; /* PHY ID register 1 */ 142 int mii_id2; /* PHY ID register 2 */ 143 int mii_capmask; /* capability mask from BMSR */ 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 __P((device_t)); 159 int miibus_attach __P((device_t)); 160 int miibus_detach __P((device_t)); 161 162 int mii_anar __P((int)); 163 int mii_mediachg __P((struct mii_data *)); 164 void mii_tick __P((struct mii_data *)); 165 void mii_pollstat __P((struct mii_data *)); 166 int mii_phy_probe __P((device_t, device_t *, 167 ifm_change_cb_t, ifm_stat_cb_t)); 168 void mii_add_media __P((struct mii_data *, int, int)); 169 170 int mii_media_from_bmcr __P((int)); 171 172 int mii_phy_auto __P((struct mii_softc *, int)); 173 void mii_phy_reset __P((struct mii_softc *)); 174 175 void ukphy_status __P((struct mii_softc *)); 176 #endif /* KERNEL */ 177 178 #endif /* _DEV_MII_MIIVAR_H_ */ 179