miivar.h revision 1.9
1/* $OpenBSD: miivar.h,v 1.9 2001/05/03 12:31:43 aaron Exp $ */ 2/* $NetBSD: miivar.h,v 1.17 2000/03/06 20:56:57 thorpej Exp $ */ 3 4/*- 5 * Copyright (c) 1998, 1999, 2000 The NetBSD Foundation, Inc. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to The NetBSD Foundation 9 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility, 10 * NASA Ames Research Center. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. All advertising materials mentioning features or use of this software 21 * must display the following acknowledgement: 22 * This product includes software developed by the NetBSD 23 * Foundation, Inc. and its contributors. 24 * 4. Neither the name of The NetBSD Foundation nor the names of its 25 * contributors may be used to endorse or promote products derived 26 * from this software without specific prior written permission. 27 * 28 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 29 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 31 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 32 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 38 * POSSIBILITY OF SUCH DAMAGE. 39 */ 40 41#ifndef _DEV_MII_MIIVAR_H_ 42#define _DEV_MII_MIIVAR_H_ 43 44#include <sys/queue.h> 45 46#if defined(__NetBSD__) 47#include <sys/callout.h> 48#elif defined(__OpenBSD__) 49#include <sys/timeout.h> 50#endif 51 52/* 53 * Media Independent Interface autoconfiguration defintions. 54 * 55 * This file exports an interface which attempts to be compatible 56 * with the BSD/OS 3.0 interface. 57 */ 58 59struct mii_softc; 60 61/* 62 * Callbacks from MII layer into network interface device driver. 63 */ 64typedef int (*mii_readreg_t) __P((struct device *, int, int)); 65typedef void (*mii_writereg_t) __P((struct device *, int, int, int)); 66typedef void (*mii_statchg_t) __P((struct device *)); 67 68/* 69 * A network interface driver has one of these structures in its softc. 70 * It is the interface from the network interface driver to the MII 71 * layer. 72 */ 73struct mii_data { 74 struct ifmedia mii_media; /* media information */ 75 struct ifnet *mii_ifp; /* pointer back to network interface */ 76 77 int mii_flags; /* misc. flags; see below */ 78 79 /* 80 * For network interfaces with multiple PHYs, a list of all 81 * PHYs is required so they can all be notified when a media 82 * request is made. 83 */ 84 LIST_HEAD(mii_listhead, mii_softc) mii_phys; 85 int mii_instance; 86 87 /* 88 * PHY driver fills this in with active media status. 89 */ 90 int mii_media_status; 91 int mii_media_active; 92 93 /* 94 * Calls from MII layer into network interface driver. 95 */ 96 mii_readreg_t mii_readreg; 97 mii_writereg_t mii_writereg; 98 mii_statchg_t mii_statchg; 99}; 100typedef struct mii_data mii_data_t; 101 102/* 103 * This call is used by the MII layer to call into the PHY driver 104 * to perform a `service request'. 105 */ 106typedef int (*mii_downcall_t) __P((struct mii_softc *, struct mii_data *, int)); 107 108/* 109 * This is a call back into the PHY driver made by a `status request'. 110 */ 111typedef void (*mii_statusreq_t) __P((struct mii_softc *)); 112 113/* 114 * Requests that can be made to the downcall. 115 */ 116#define MII_TICK 1 /* once-per-second tick */ 117#define MII_MEDIACHG 2 /* user changed media; perform the switch */ 118#define MII_POLLSTAT 3 /* user requested media status; fill it in */ 119#define MII_DOWN 4 /* interface is down */ 120 121/* 122 * Each PHY driver's softc has one of these as the first member. 123 * XXX This would be better named "phy_softc", but this is the name 124 * XXX BSDI used, and we would like to have the same interface. 125 */ 126struct mii_softc { 127 struct device mii_dev; /* generic device glue */ 128 129 LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */ 130 131 int mii_phy; /* our MII address */ 132 int mii_offset; /* first PHY, second PHY, etc. */ 133 int mii_inst; /* instance for ifmedia */ 134 135 mii_downcall_t mii_service; /* our downcall */ 136 mii_statusreq_t mii_status; /* our status request fn */ 137 struct mii_data *mii_pdata; /* pointer to parent's mii_data */ 138 139 int mii_flags; /* misc. flags; see below */ 140 int mii_capabilities; /* capabilities from BMSR */ 141 int mii_ticks; /* MII_TICK counter */ 142 143#if defined(__NetBSD__) 144 struct callout mii_nway_ch; /* NWAY callout */ 145#endif 146 147 int mii_media_active; /* last active media */ 148 int mii_media_status; /* last active status */ 149 150 struct timeout mii_phy_timo; /* timeout handle */ 151}; 152typedef struct mii_softc mii_softc_t; 153 154/* mii_flags */ 155#define MIIF_INITDONE 0x0001 /* has been initialized (mii_data) */ 156#define MIIF_NOISOLATE 0x0002 /* do not isolate the PHY */ 157#define MIIF_NOLOOP 0x0004 /* no loopback capability */ 158#define MIIF_DOINGAUTO 0x0008 /* doing autonegotiation (mii_softc) */ 159#define MIIF_AUTOTSLEEP 0x0010 /* use tsleep(), not timeout() */ 160 161#define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP) 162 163/* 164 * Special `locators' passed to mii_attach(). If one of these is not 165 * an `any' value, we look for *that* PHY and configure it. If both 166 * are not `any', that is an error, and mii_attach() will panic. 167 */ 168#define MII_OFFSET_ANY -1 169#define MII_PHY_ANY -1 170 171/* 172 * Used to attach a PHY to a parent. 173 */ 174struct mii_attach_args { 175 struct mii_data *mii_data; /* pointer to parent data */ 176 int mii_phyno; /* MII address */ 177 int mii_id1; /* PHY ID register 1 */ 178 int mii_id2; /* PHY ID register 2 */ 179 int mii_capmask; /* capability mask from BMSR */ 180 int mii_flags; /* flags from parent */ 181}; 182typedef struct mii_attach_args mii_attach_args_t; 183 184/* 185 * An array of these structures map MII media types to BMCR/ANAR settings. 186 */ 187struct mii_media { 188 int mm_bmcr; /* BMCR settings for this media */ 189 int mm_anar; /* ANAR settings for this media */ 190}; 191 192#define MII_MEDIA_NONE 0 193#define MII_MEDIA_10_T 1 194#define MII_MEDIA_10_T_FDX 2 195#define MII_MEDIA_100_T4 3 196#define MII_MEDIA_100_TX 4 197#define MII_MEDIA_100_TX_FDX 5 198#define MII_NMEDIA 6 199 200#ifdef _KERNEL 201 202#define PHY_READ(p, r) \ 203 (*(p)->mii_pdata->mii_readreg)((p)->mii_dev.dv_parent, \ 204 (p)->mii_phy, (r)) 205 206#define PHY_WRITE(p, r, v) \ 207 (*(p)->mii_pdata->mii_writereg)((p)->mii_dev.dv_parent, \ 208 (p)->mii_phy, (r), (v)) 209 210#define mii_phy_probe(x, y, z) \ 211 mii_attach((x), (y), (z), MII_PHY_ANY, MII_OFFSET_ANY, 0) 212 213void mii_attach __P((struct device *, struct mii_data *, int, int, 214 int, int)); 215void mii_activate __P((struct mii_data *, enum devact, int, int)); 216void mii_detach __P((struct mii_data *, int, int)); 217 218int mii_mediachg __P((struct mii_data *)); 219void mii_tick __P((struct mii_data *)); 220void mii_pollstat __P((struct mii_data *)); 221void mii_down __P((struct mii_data *)); 222 223int mii_phy_activate __P((struct device *, enum devact)); 224int mii_phy_detach __P((struct device *, int)); 225 226void mii_phy_add_media __P((struct mii_softc *)); 227void mii_phy_delete_media __P((struct mii_softc *)); 228 229void mii_phy_setmedia __P((struct mii_softc *)); 230int mii_phy_auto __P((struct mii_softc *, int)); 231void mii_phy_reset __P((struct mii_softc *)); 232void mii_phy_down __P((struct mii_softc *)); 233int mii_phy_tick __P((struct mii_softc *)); 234 235void mii_phy_status __P((struct mii_softc *)); 236void mii_phy_update __P((struct mii_softc *, int)); 237void mii_phy_statusmsg __P((struct mii_softc *)); 238 239void ukphy_status __P((struct mii_softc *)); 240#endif /* _KERNEL */ 241 242#endif /* _DEV_MII_MIIVAR_H_ */ 243