sys/dev/mii/miivar.h

   1 /*      $NetBSD: miivar.h,v 1.56 2009/12/04 22:37:35 dyoung 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  *
  20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30  * POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #ifndef _DEV_MII_MIIVAR_H_
  34 #define _DEV_MII_MIIVAR_H_
  35
  36 #include <sys/queue.h>
  37 #include <sys/callout.h>
  38
  39 /*
  40  * Media Independent Interface datat structure definitions.
  41  */
  42
  43 struct mii_softc;
  44
  45 /*
  46  * Callbacks from MII layer into network interface device driver.
  47  */
  48 typedef int (*mii_readreg_t)(device_t, int, int);
  49 typedef void (*mii_writereg_t)(device_t, int, int, int);
  50 typedef void (*mii_statchg_t)(device_t);
  51
  52 /*
  53  * A network interface driver has one of these structures in its softc.
  54  * It is the interface from the network interface driver to the MII
  55  * layer.
  56  */
  57 struct mii_data {
  58         struct ifmedia mii_media;       /* media information */
  59         struct ifnet *mii_ifp;          /* pointer back to network interface */
  60
  61         int mii_flags;                  /* misc. flags; see below */
  62
  63         /*
  64          * For network interfaces with multiple PHYs, a list of all
  65          * PHYs is required so they can all be notified when a media
  66          * request is made.
  67          */
  68         LIST_HEAD(mii_listhead, mii_softc) mii_phys;
  69         u_int mii_instance;
  70
  71         /*
  72          * PHY driver fills this in with active media status.
  73          */
  74         int mii_media_status;
  75         u_int mii_media_active;
  76
  77         /*
  78          * Calls from MII layer into network interface driver.
  79          */
  80         mii_readreg_t mii_readreg;
  81         mii_writereg_t mii_writereg;
  82         mii_statchg_t mii_statchg;
  83 };
  84 typedef struct mii_data mii_data_t;
  85
  86 /*
  87  * Functions provided by the PHY to perform various functions.
  88  */
  89 struct mii_phy_funcs {
  90         int (*pf_service)(struct mii_softc *, struct mii_data *, int);
  91         void (*pf_status)(struct mii_softc *);
  92         void (*pf_reset)(struct mii_softc *);
  93 };
  94
  95 /*
  96  * Requests that can be made to the downcall.
  97  */
  98 #define MII_TICK        1       /* once-per-second tick */
  99 #define MII_MEDIACHG    2       /* user changed media; perform the switch */
 100 #define MII_POLLSTAT    3       /* user requested media status; fill it in */
 101 #define MII_DOWN        4       /* interface is down */
 102
 103 /*
 104  * Each PHY driver's softc has one of these as the first member.
 105  * XXX This would be better named "phy_softc", but this is the name
 106  * XXX BSDI used, and we would like to have the same interface.
 107  */
 108 struct mii_softc {
 109         device_t mii_dev;               /* generic device glue */
 110
 111         LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */
 112
 113         uint32_t mii_mpd_model;         /* the PHY's model (MII_MODEL())*/
 114         uint32_t mii_mpd_rev;           /* the PHY's revision (MII_REV())*/
 115         int mii_phy;                    /* our MII address */
 116         int mii_offset;                 /* first PHY, second PHY, etc. */
 117         u_int mii_inst;                 /* instance for ifmedia */
 118
 119         /* Our PHY functions. */
 120         const struct mii_phy_funcs *mii_funcs;
 121
 122         struct mii_data *mii_pdata;     /* pointer to parent's mii_data */
 123
 124         int mii_flags;                  /* misc. flags; see below */
 125         int mii_capabilities;           /* capabilities from BMSR */
 126         int mii_extcapabilities;        /* extended capabilities */
 127         int mii_ticks;                  /* MII_TICK counter */
 128         int mii_anegticks;              /* ticks before retrying aneg */
 129
 130         struct callout mii_nway_ch;     /* NWAY callout */
 131
 132         u_int mii_media_active;         /* last active media */
 133         int mii_media_status;           /* last active status */
 134 };
 135 typedef struct mii_softc mii_softc_t;
 136
 137 /* Default mii_anegticks values. */
 138 #define MII_ANEGTICKS           5
 139 #define MII_ANEGTICKS_GIGE      10
 140
 141 /* mii_flags */
 142 #define MIIF_INITDONE   0x0001          /* has been initialized (mii_data) */
 143 #define MIIF_NOISOLATE  0x0002          /* do not isolate the PHY */
 144 #define MIIF_NOLOOP     0x0004          /* no loopback capability */
 145 #define MIIF_DOINGAUTO  0x0008          /* doing autonegotiation (mii_softc) */
 146 #define MIIF_AUTOTSLEEP 0x0010          /* use tsleep(), not callout() */
 147 #define MIIF_HAVEFIBER  0x0020          /* from parent: has fiber interface */
 148 #define MIIF_HAVE_GTCR  0x0040          /* has 100base-T2/1000base-T CR */
 149 #define MIIF_IS_1000X   0x0080          /* is a 1000BASE-X device */
 150 #define MIIF_DOPAUSE    0x0100          /* advertise PAUSE capability */
 151 #define MIIF_IS_HPNA    0x0200          /* is a HomePNA device */
 152 #define MIIF_FORCEANEG  0x0400          /* force auto-negotiation */
 153
 154 #define MIIF_INHERIT_MASK       (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP)
 155
 156 /*
 157  * Special `locators' passed to mii_attach().  If one of these is not
 158  * an `any' value, we look for *that* PHY and configure it.  If both
 159  * are not `any', that is an error, and mii_attach() will panic.
 160  */
 161 #define MII_OFFSET_ANY          -1
 162 #define MII_PHY_ANY             -1
 163
 164 /*
 165  * Used to attach a PHY to a parent.
 166  */
 167 struct mii_attach_args {
 168         struct mii_data *mii_data;      /* pointer to parent data */
 169         int mii_phyno;                  /* MII address */
 170         u_int mii_id1;                  /* PHY ID register 1 */
 171         u_int mii_id2;                  /* PHY ID register 2 */
 172         int mii_capmask;                /* capability mask from BMSR */
 173         int mii_flags;                  /* flags from parent */
 174 };
 175 typedef struct mii_attach_args mii_attach_args_t;
 176
 177 /*
 178  * Used to match a PHY.
 179  */
 180 struct mii_phydesc {
 181         u_int32_t mpd_oui;              /* the PHY's OUI */
 182         u_int32_t mpd_model;            /* the PHY's model */
 183         const char *mpd_name;           /* the PHY's name */
 184 };
 185
 186 /*
 187  * An array of these structures map MII media types to BMCR/ANAR settings.
 188  */
 189 struct mii_media {
 190         int     mm_bmcr;                /* BMCR settings for this media */
 191         int     mm_anar;                /* ANAR settings for this media */
 192         int     mm_gtcr;                /* 100base-T2 or 1000base-T CR */
 193 };
 194
 195 #define MII_MEDIA_NONE          0
 196 #define MII_MEDIA_10_T          1
 197 #define MII_MEDIA_10_T_FDX      2
 198 #define MII_MEDIA_100_T4        3
 199 #define MII_MEDIA_100_TX        4
 200 #define MII_MEDIA_100_TX_FDX    5
 201 #define MII_MEDIA_1000_X        6
 202 #define MII_MEDIA_1000_X_FDX    7
 203 #define MII_MEDIA_1000_T        8
 204 #define MII_MEDIA_1000_T_FDX    9
 205 #define MII_NMEDIA              10
 206
 207 #ifdef _KERNEL
 208
 209 #define PHY_READ(p, r) \
 210         (*(p)->mii_pdata->mii_readreg)(device_parent((p)->mii_dev), \
 211             (p)->mii_phy, (r))
 212
 213 #define PHY_WRITE(p, r, v) \
 214         (*(p)->mii_pdata->mii_writereg)(device_parent((p)->mii_dev), \
 215             (p)->mii_phy, (r), (v))
 216
 217 #define PHY_SERVICE(p, d, o) \
 218         (*(p)->mii_funcs->pf_service)((p), (d), (o))
 219
 220 #define PHY_STATUS(p) \
 221         (*(p)->mii_funcs->pf_status)((p))
 222
 223 #define PHY_RESET(p) \
 224         (*(p)->mii_funcs->pf_reset)((p))
 225
 226 void    mii_attach(device_t, struct mii_data *, int, int, int, int);
 227 void    mii_detach(struct mii_data *, int, int);
 228 bool    mii_phy_resume(device_t, pmf_qual_t);
 229
 230 int     mii_mediachg(struct mii_data *);
 231 void    mii_tick(struct mii_data *);
 232 void    mii_pollstat(struct mii_data *);
 233 void    mii_down(struct mii_data *);
 234 int     mii_anar(int);
 235
 236 int mii_ifmedia_change(struct mii_data *);
 237
 238 int     mii_phy_activate(device_t, enum devact);
 239 int     mii_phy_detach(device_t, int);
 240
 241 const struct mii_phydesc *mii_phy_match(const struct mii_attach_args *,
 242             const struct mii_phydesc *);
 243
 244 void    mii_phy_add_media(struct mii_softc *);
 245 void    mii_phy_delete_media(struct mii_softc *);
 246
 247 void    mii_phy_setmedia(struct mii_softc *);
 248 int     mii_phy_auto(struct mii_softc *, int);
 249 void    mii_phy_reset(struct mii_softc *);
 250 void    mii_phy_down(struct mii_softc *);
 251 int     mii_phy_tick(struct mii_softc *);
 252
 253 void    mii_phy_status(struct mii_softc *);
 254 void    mii_phy_update(struct mii_softc *, int);
 255
 256 u_int   mii_phy_flowstatus(struct mii_softc *);
 257
 258 void    ukphy_status(struct mii_softc *);
 259
 260 u_int   mii_oui(u_int, u_int);
 261 #define MII_OUI(id1, id2)       mii_oui(id1, id2)
 262 #define MII_MODEL(id2)          (((id2) & IDR2_MODEL) >> 4)
 263 #define MII_REV(id2)            ((id2) & IDR2_REV)
 264
 265 #endif /* _KERNEL */
 266
 267 #endif /* _DEV_MII_MIIVAR_H_ */