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