miivar.h revision 1.14
1/* $OpenBSD: miivar.h,v 1.14 2002/03/14 01:26:57 millert 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)(struct device *, int, int); 65typedef void (*mii_writereg_t)(struct device *, int, int, int); 66typedef void (*mii_statchg_t)(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)(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)(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_extcapabilities; /* extended capabilities */ 142 int mii_ticks; /* MII_TICK counter */ 143 int mii_anegticks; /* ticks before retrying aneg */ 144 145#if defined(__NetBSD__) 146 struct callout mii_nway_ch; /* NWAY callout */ 147#elif defined(__OpenBSD__) 148 struct timeout mii_phy_timo; /* timeout handle */ 149#endif 150 151 int mii_media_active; /* last active media */ 152 int mii_media_status; /* last active status */ 153}; 154typedef struct mii_softc mii_softc_t; 155 156/* mii_flags */ 157#define MIIF_INITDONE 0x0001 /* has been initialized (mii_data) */ 158#define MIIF_NOISOLATE 0x0002 /* do not isolate the PHY */ 159#define MIIF_NOLOOP 0x0004 /* no loopback capability */ 160#define MIIF_DOINGAUTO 0x0008 /* doing autonegotiation (mii_softc) */ 161#define MIIF_AUTOTSLEEP 0x0010 /* use tsleep(), not timeout() */ 162#define MIIF_HAVEFIBER 0x0020 /* from parent: has fiber interface */ 163#define MIIF_HAVE_GTCR 0x0040 /* has 100base-T2/1000base-T CR */ 164 165#define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP) 166 167/* 168 * Special `locators' passed to mii_attach(). If one of these is not 169 * an `any' value, we look for *that* PHY and configure it. If both 170 * are not `any', that is an error, and mii_attach() will panic. 171 */ 172#define MII_OFFSET_ANY -1 173#define MII_PHY_ANY -1 174 175/* 176 * Used to attach a PHY to a parent. 177 */ 178struct mii_attach_args { 179 struct mii_data *mii_data; /* pointer to parent data */ 180 int mii_phyno; /* MII address */ 181 int mii_id1; /* PHY ID register 1 */ 182 int mii_id2; /* PHY ID register 2 */ 183 int mii_capmask; /* capability mask from BMSR */ 184 int mii_flags; /* flags from parent */ 185}; 186typedef struct mii_attach_args mii_attach_args_t; 187 188/* 189 * An array of these structures map MII media types to BMCR/ANAR settings. 190 */ 191struct mii_media { 192 int mm_bmcr; /* BMCR settings for this media */ 193 int mm_anar; /* ANAR settings for this media */ 194 int mm_gtcr; /* 100base-T2 or 1000base-T CR */ 195}; 196 197#define MII_MEDIA_NONE 0 198#define MII_MEDIA_10_T 1 199#define MII_MEDIA_10_T_FDX 2 200#define MII_MEDIA_100_T4 3 201#define MII_MEDIA_100_TX 4 202#define MII_MEDIA_100_TX_FDX 5 203#define MII_MEDIA_1000_X 6 204#define MII_MEDIA_1000_X_FDX 7 205#define MII_MEDIA_1000_T 8 206#define MII_MEDIA_1000_T_FDX 9 207#define MII_NMEDIA 10 208 209#ifdef _KERNEL 210 211#define PHY_READ(p, r) \ 212 (*(p)->mii_pdata->mii_readreg)((p)->mii_dev.dv_parent, \ 213 (p)->mii_phy, (r)) 214 215#define PHY_WRITE(p, r, v) \ 216 (*(p)->mii_pdata->mii_writereg)((p)->mii_dev.dv_parent, \ 217 (p)->mii_phy, (r), (v)) 218 219#define mii_phy_probe(x, y, z) \ 220 mii_attach((x), (y), (z), MII_PHY_ANY, MII_OFFSET_ANY, 0) 221 222void mii_attach(struct device *, struct mii_data *, int, int, 223 int, int); 224void mii_activate(struct mii_data *, enum devact, int, int); 225void mii_detach(struct mii_data *, int, int); 226 227int mii_mediachg(struct mii_data *); 228void mii_tick(struct mii_data *); 229void mii_pollstat(struct mii_data *); 230void mii_down(struct mii_data *); 231 232int mii_phy_activate(struct device *, enum devact); 233int mii_phy_detach(struct device *, int); 234 235void mii_phy_add_media(struct mii_softc *); 236void mii_phy_delete_media(struct mii_softc *); 237 238void mii_phy_setmedia(struct mii_softc *); 239int mii_phy_auto(struct mii_softc *, int); 240void mii_phy_reset(struct mii_softc *); 241void mii_phy_down(struct mii_softc *); 242int mii_phy_tick(struct mii_softc *); 243 244void mii_phy_status(struct mii_softc *); 245void mii_phy_update(struct mii_softc *, int); 246void mii_phy_statusmsg(struct mii_softc *); 247 248void ukphy_status(struct mii_softc *); 249 250int mii_anar(int); 251#endif /* _KERNEL */ 252 253#endif /* _DEV_MII_MIIVAR_H_ */ 254