miivar.h revision 1.20
1/* $OpenBSD: miivar.h,v 1.20 2004/09/27 18:25:48 brad 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#include <sys/timeout.h> 46 47/* 48 * Media Independent Interface autoconfiguration definitions. 49 * 50 * This file exports an interface which attempts to be compatible 51 * with the BSD/OS 3.0 interface. 52 */ 53 54struct mii_softc; 55 56/* 57 * Callbacks from MII layer into network interface device driver. 58 */ 59typedef int (*mii_readreg_t)(struct device *, int, int); 60typedef void (*mii_writereg_t)(struct device *, int, int, int); 61typedef void (*mii_statchg_t)(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 */ 68struct mii_data { 69 struct ifmedia mii_media; /* media information */ 70 struct ifnet *mii_ifp; /* pointer back to network interface */ 71 72 int mii_flags; /* misc. flags; see below */ 73 74 /* 75 * For network interfaces with multiple PHYs, a list of all 76 * PHYs is required so they can all be notified when a media 77 * request is made. 78 */ 79 LIST_HEAD(mii_listhead, mii_softc) mii_phys; 80 int mii_instance; 81 82 /* 83 * PHY driver fills this in with active media status. 84 */ 85 int mii_media_status; 86 int mii_media_active; 87 88 /* 89 * Calls from MII layer into network interface driver. 90 */ 91 mii_readreg_t mii_readreg; 92 mii_writereg_t mii_writereg; 93 mii_statchg_t mii_statchg; 94}; 95typedef struct mii_data mii_data_t; 96 97struct mii_phy_funcs { 98 int (*pf_service)(struct mii_softc *, struct mii_data *, int); 99 void (*pf_status)(struct mii_softc *); 100 void (*pf_reset)(struct mii_softc *); 101}; 102 103/* 104 * Requests that can be made to the downcall. 105 */ 106#define MII_TICK 1 /* once-per-second tick */ 107#define MII_MEDIACHG 2 /* user changed media; perform the switch */ 108#define MII_POLLSTAT 3 /* user requested media status; fill it in */ 109#define MII_DOWN 4 /* interface is down */ 110 111/* 112 * Each PHY driver's softc has one of these as the first member. 113 * XXX This would be better named "phy_softc", but this is the name 114 * XXX BSDI used, and we would like to have the same interface. 115 */ 116struct mii_softc { 117 struct device mii_dev; /* generic device glue */ 118 119 LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */ 120 121 int mii_phy; /* our MII address */ 122 int mii_model; /* MII_MODEL(ma->mii_id2) */ 123 int mii_rev; /* MII_REV(ma->mii_id2) */ 124 int mii_offset; /* first PHY, second PHY, etc. */ 125 int mii_inst; /* instance for ifmedia */ 126 127 /* Our PHY functions. */ 128 const struct mii_phy_funcs *mii_funcs; 129 130 struct mii_data *mii_pdata; /* pointer to parent's mii_data */ 131 132 int mii_flags; /* misc. flags; see below */ 133 int mii_capabilities; /* capabilities from BMSR */ 134 int mii_extcapabilities; /* extended capabilities */ 135 int mii_ticks; /* MII_TICK counter */ 136 int mii_anegticks; /* ticks before retrying aneg */ 137 138 struct timeout mii_phy_timo; /* timeout handle */ 139 140 int mii_media_active; /* last active media */ 141 int mii_media_status; /* last active status */ 142}; 143typedef struct mii_softc mii_softc_t; 144 145/* mii_flags */ 146#define MIIF_INITDONE 0x0001 /* has been initialized (mii_data) */ 147#define MIIF_NOISOLATE 0x0002 /* do not isolate the PHY */ 148#define MIIF_NOLOOP 0x0004 /* no loopback capability */ 149#define MIIF_DOINGAUTO 0x0008 /* doing autonegotiation (mii_softc) */ 150#define MIIF_AUTOTSLEEP 0x0010 /* use tsleep(), not timeout() */ 151#define MIIF_HAVEFIBER 0x0020 /* from parent: has fiber interface */ 152#define MIIF_HAVE_GTCR 0x0040 /* has 100base-T2/1000base-T CR */ 153#define MIIF_IS_1000X 0x0080 /* is a 1000BASE-X device */ 154#define MIIF_DOPAUSE 0x0100 /* advertise PAUSE capability */ 155#define MIIF_IS_HPNA 0x0200 /* is a HomePNA device */ 156#define MIIF_FORCEANEG 0x0400 /* force autonegotiation */ 157 158#define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP) 159 160/* 161 * Special `locators' passed to mii_attach(). If one of these is not 162 * an `any' value, we look for *that* PHY and configure it. If both 163 * are not `any', that is an error, and mii_attach() will panic. 164 */ 165#define MII_OFFSET_ANY -1 166#define MII_PHY_ANY -1 167 168/* 169 * Used to attach a PHY to a parent. 170 */ 171struct mii_attach_args { 172 struct mii_data *mii_data; /* pointer to parent data */ 173 int mii_phyno; /* MII address */ 174 int mii_id1; /* PHY ID register 1 */ 175 int mii_id2; /* PHY ID register 2 */ 176 int mii_capmask; /* capability mask from BMSR */ 177 int mii_flags; /* flags from parent */ 178}; 179typedef struct mii_attach_args mii_attach_args_t; 180 181/* 182 * An array of these structures map MII media types to BMCR/ANAR settings. 183 */ 184struct mii_media { 185 int mm_bmcr; /* BMCR settings for this media */ 186 int mm_anar; /* ANAR settings for this media */ 187 int mm_gtcr; /* 100base-T2 or 1000base-T CR */ 188}; 189 190#define MII_MEDIA_NONE 0 191#define MII_MEDIA_10_T 1 192#define MII_MEDIA_10_T_FDX 2 193#define MII_MEDIA_100_T4 3 194#define MII_MEDIA_100_TX 4 195#define MII_MEDIA_100_TX_FDX 5 196#define MII_MEDIA_1000_X 6 197#define MII_MEDIA_1000_X_FDX 7 198#define MII_MEDIA_1000_T 8 199#define MII_MEDIA_1000_T_FDX 9 200#define MII_NMEDIA 10 201 202#ifdef _KERNEL 203 204#define PHY_READ(p, r) \ 205 (*(p)->mii_pdata->mii_readreg)((p)->mii_dev.dv_parent, \ 206 (p)->mii_phy, (r)) 207 208#define PHY_WRITE(p, r, v) \ 209 (*(p)->mii_pdata->mii_writereg)((p)->mii_dev.dv_parent, \ 210 (p)->mii_phy, (r), (v)) 211 212#define PHY_SERVICE(p, d, o) \ 213 (*(p)->mii_funcs->pf_service)((p), (d), (o)) 214 215#define PHY_STATUS(p) \ 216 (*(p)->mii_funcs->pf_status)((p)) 217 218#define PHY_RESET(p) \ 219 (*(p)->mii_funcs->pf_reset)((p)) 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