sys/dev/netif/mii_layer/miivar.h

   1 /*      $NetBSD: miivar.h,v 1.46 2006/03/25 23:17:36 thorpej Exp $      */
   2
   3 /*-
   4  * Copyright (c) 1998, 1999, 2000, 2001 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: src/sys/dev/mii/miivar.h,v 1.3.2.1 2000/12/12 19:29:14 wpaul Exp $
  40  * $DragonFly: src/sys/dev/netif/mii_layer/miivar.h,v 1.12 2006/08/06 10:32:23 sephe Exp $
  41  */
  42
  43 #ifndef _DEV_MII_MIIVAR_H_
  44 #define _DEV_MII_MIIVAR_H_
  45
  46 #include <sys/queue.h>
  47
  48 /*
  49  * Media Independent Interface autoconfiguration defintions.
  50  *
  51  * This file exports an interface which attempts to be compatible
  52  * with the BSD/OS 3.0 interface.
  53  */
  54
  55 struct mii_softc;
  56
  57 /*
  58  * A network interface driver has one of these structures in its softc.
  59  * It is the interface from the network interface driver to the MII
  60  * layer.
  61  */
  62 struct mii_data {
  63         struct ifmedia mii_media;       /* media information */
  64         struct ifnet *mii_ifp;          /* pointer back to network interface */
  65
  66         /*
  67          * For network interfaces with multiple PHYs, a list of all
  68          * PHYs is required so they can all be notified when a media
  69          * request is made.
  70          */
  71         LIST_HEAD(mii_listhead, mii_softc) mii_phys;
  72         int mii_instance;
  73
  74         /*
  75          * PHY driver fills this in with active media status.
  76          */
  77         int mii_media_status;
  78         int mii_media_active;
  79 };
  80 typedef struct mii_data mii_data_t;
  81
  82 /*
  83  * Requests that can be made to the downcall.
  84  */
  85 #define MII_TICK        1       /* once-per-second tick */
  86 #define MII_MEDIACHG    2       /* user changed media; perform the switch */
  87 #define MII_POLLSTAT    3       /* user requested media status; fill it in */
  88
  89 /*
  90  * Each PHY driver's softc has one of these as the first member.
  91  * XXX This would be better named "phy_softc", but this is the name
  92  * XXX BSDI used, and we would like to have the same interface.
  93  */
  94 struct mii_softc {
  95         device_t mii_dev;               /* generic device glue */
  96
  97         LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */
  98
  99         int mii_model;                  /* MII_MODEL(ma->mii_id2) */
 100         int mii_rev;                    /* MII_REV(ma->mii_id2) */
 101         int mii_phy;                    /* our MII address */
 102         int mii_inst;                   /* instance for ifmedia */
 103
 104         /*
 105          * This function pointer is used by the MII layer to call into
 106          * the PHY driver to perform a `service request'.
 107          */
 108         int (*mii_service)(struct mii_softc *, struct mii_data *, int);
 109
 110         /*
 111          * This function pointer is used by the MII layer to reset PHY
 112          */
 113         void (*mii_reset)(struct mii_softc *);
 114
 115         /*
 116          * This function pointer is used by the MII layer to get the
 117          * status of PHY
 118          */
 119         void (*mii_status)(struct mii_softc *);
 120
 121         struct mii_data *mii_pdata;     /* pointer to parent's mii_data */
 122         struct callout  mii_auto_ch;    /* callout handle for phy autoneg */
 123
 124         int mii_flags;                  /* misc. flags; see below */
 125         int mii_capabilities;           /* capabilities from BMSR */
 126         int mii_extcapabilities;        /* extended capabilities from EXTSR */
 127         int mii_ticks;                  /* MII_TICK counter */
 128         int mii_anegticks;              /* ticks before retrying aneg */
 129
 130         int mii_media_active;           /* last active media */
 131         int mii_media_status;           /* last active status */
 132 };
 133 typedef struct mii_softc mii_softc_t;
 134
 135 /* mii_flags */
 136 #define MIIF_INITDONE   0x0001          /* has been initialized (mii_data) */
 137 #define MIIF_NOISOLATE  0x0002          /* do not isolate the PHY */
 138 #define MIIF_NOLOOP     0x0004          /* no loopback capability */
 139 #define MIIF_DOINGAUTO  0x0008          /* doing autonegotiation (mii_softc) */
 140 #define MIIF_AUTOTSLEEP 0x0010          /* use tsleep(), not callout() */
 141 #define MIIF_HAVEFIBER  0x0020          /* from parent: has fiber interface */
 142 #define MIIF_HAVE_GTCR  0x0040          /* has 100base-T2/1000base-T CR */
 143 #define MIIF_IS_1000X   0x0080          /* is a 1000BASE-X device */
 144 #define MIIF_DOPAUSE    0x0100          /* advertise PAUSE capability */
 145 #define MIIF_IS_HPNA    0x0200          /* is a HomePNA device */
 146 #define MIIF_FORCEANEG  0x0400          /* is a HomePNA device */
 147
 148 #define MIIF_INHERIT_MASK       (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP)
 149
 150 /*
 151  * Used to attach a PHY to a parent.
 152  */
 153 struct mii_attach_args {
 154         struct mii_data *mii_data;      /* pointer to parent data */
 155         int mii_phyno;                  /* MII address */
 156         int mii_id1;                    /* PHY ID register 1 */
 157         int mii_id2;                    /* PHY ID register 2 */
 158         int mii_capmask;                /* capability mask from BMSR */
 159         int mii_flags;                  /* inherited by mii_softc->mii_flags */
 160 };
 161 typedef struct mii_attach_args mii_attach_args_t;
 162
 163 /*
 164  * Used to match a PHY
 165  */
 166 struct mii_phydesc {
 167         uint32_t mpd_oui;       /* PHY's oui */
 168         uint32_t mpd_model;     /* PHY's model */
 169         const char *mpd_name;   /* PHY's name */
 170         void *mpd_priv;         /* PHY's private data */
 171 };
 172
 173 #define MII_PHYDESC_NULL \
 174 { \
 175         .mpd_oui = 0, \
 176         .mpd_model = 0, \
 177         .mpd_name = NULL, \
 178         .mpd_priv = NULL \
 179 }
 180 #define MII_PHYDESC(oui, model) \
 181 { \
 182         .mpd_oui        = MII_OUI_##oui, \
 183         .mpd_model      = MII_MODEL_##oui##_##model, \
 184         .mpd_name       = MII_STR_##oui##_##model, \
 185         .mpd_priv       = NULL \
 186 }
 187 #define MII_PHYDESC_ARG(oui, model, arg) \
 188 { \
 189         .mpd_oui        = MII_OUI_##oui, \
 190         .mpd_model      = MII_MODEL_##oui##_##model, \
 191         .mpd_name       = MII_STR_##oui##_##model, \
 192         .mpd_priv       = arg \
 193 }
 194
 195 #ifdef _KERNEL
 196
 197 #define PHY_READ(p, r) \
 198         MIIBUS_READREG((p)->mii_dev, (p)->mii_phy, (r))
 199
 200 #define PHY_WRITE(p, r, v) \
 201         MIIBUS_WRITEREG((p)->mii_dev, (p)->mii_phy, (r), (v))
 202
 203 /*
 204  * An array of these structures map MII media types to BMCR/ANAR settings.
 205  */
 206 struct mii_media {
 207         int     mm_bmcr;                /* BMCR settings for this media */
 208         int     mm_anar;                /* ANAR settings for this media */
 209         int     mm_gtcr;                /* 100base-T2 or 1000base-T CR */
 210 };
 211
 212 #define MII_MEDIA_NONE          0
 213 #define MII_MEDIA_10_T          1
 214 #define MII_MEDIA_10_T_FDX      2
 215 #define MII_MEDIA_100_T4        3
 216 #define MII_MEDIA_100_TX        4
 217 #define MII_MEDIA_100_TX_FDX    5
 218 #define MII_MEDIA_1000_X        6
 219 #define MII_MEDIA_1000_X_FDX    7
 220 #define MII_MEDIA_1000_T        8
 221 #define MII_MEDIA_1000_T_FDX    9
 222 #define MII_NMEDIA              10
 223
 224 extern const struct mii_media   mii_media_table[MII_NMEDIA];
 225
 226 #define MII_ANEGTICKS           5
 227 #define MII_ANEGTICKS_GIGE      10
 228
 229 extern devclass_t       miibus_devclass;
 230 extern driver_t         miibus_driver;
 231
 232 int     miibus_probe(device_t);
 233 int     miibus_attach(device_t);
 234 int     miibus_detach(device_t);
 235
 236 int     mii_mediachg(struct mii_data *);
 237 void    mii_tick(struct mii_data *);
 238 void    mii_pollstat(struct mii_data *);
 239 int     mii_phy_probe(device_t, device_t *, ifm_change_cb_t, ifm_stat_cb_t);
 240
 241 void    mii_phy_add_media(struct mii_softc *);
 242 void    mii_phy_set_media(struct mii_softc *);
 243 int     mii_phy_tick(struct mii_softc *);
 244 void    mii_phy_update(struct mii_softc *, int);
 245 int     mii_phy_flowstatus(struct mii_softc *);
 246 const struct mii_phydesc *mii_phy_match(const struct mii_attach_args *,
 247                                         const struct mii_phydesc *);
 248
 249 void    mii_softc_init(struct mii_softc *, struct mii_attach_args *);
 250
 251 int     mii_phy_auto(struct mii_softc *, int);
 252 void    mii_phy_auto_stop(struct mii_softc *);
 253 void    mii_phy_auto_timeout(void *arg);
 254 void    mii_phy_reset(struct mii_softc *);
 255
 256 void    ukphy_status(struct mii_softc *);
 257 int     ukphy_attach(device_t);
 258 int     ukphy_detach(device_t);
 259
 260 #endif /* _KERNEL */
 261
 262 #endif /* _DEV_MII_MIIVAR_H_ */