sys/dev/mii/miivar.h

   1 /*      $NetBSD: miivar.h,v 1.8 1999/04/23 04:24:32 thorpej Exp $       */
   2
   3 /*-
   4  * SPDX-License-Identifier: BSD-2-Clause-NetBSD
   5  *
   6  * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
   7  * All rights reserved.
   8  *
   9  * This code is derived from software contributed to The NetBSD Foundation
  10  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
  11  * NASA Ames Research Center.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  24  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  25  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32  * POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  * $FreeBSD$
  35  */
  36
  37 #ifndef _DEV_MII_MIIVAR_H_
  38 #define _DEV_MII_MIIVAR_H_
  39
  40 #include <sys/queue.h>
  41 #include <net/if_var.h> /* XXX driver API temporary */
  42
  43 /*
  44  * Media Independent Interface data structure defintions
  45  */
  46
  47 struct mii_softc;
  48
  49 /*
  50  * A network interface driver has one of these structures in its softc.
  51  * It is the interface from the network interface driver to the MII
  52  * layer.
  53  */
  54 struct mii_data {
  55         struct ifmedia mii_media;       /* media information */
  56         if_t mii_ifp;           /* pointer back to network interface */
  57
  58         /*
  59          * For network interfaces with multiple PHYs, a list of all
  60          * PHYs is required so they can all be notified when a media
  61          * request is made.
  62          */
  63         LIST_HEAD(mii_listhead, mii_softc) mii_phys;
  64         u_int mii_instance;
  65
  66         /*
  67          * PHY driver fills this in with active media status.
  68          */
  69         u_int mii_media_status;
  70         u_int mii_media_active;
  71 };
  72 typedef struct mii_data mii_data_t;
  73
  74 /*
  75  * Functions provided by the PHY to perform various functions.
  76  */
  77 struct mii_phy_funcs {
  78         int (*pf_service)(struct mii_softc *, struct mii_data *, int);
  79         void (*pf_status)(struct mii_softc *);
  80         void (*pf_reset)(struct mii_softc *);
  81 };
  82
  83 /*
  84  * Requests that can be made to the downcall.
  85  */
  86 #define MII_TICK        1       /* once-per-second tick */
  87 #define MII_MEDIACHG    2       /* user changed media; perform the switch */
  88 #define MII_POLLSTAT    3       /* user requested media status; fill it in */
  89
  90 /*
  91  * Each PHY driver's softc has one of these as the first member.
  92  * XXX This would be better named "phy_softc", but this is the name
  93  * XXX BSDI used, and we would like to have the same interface.
  94  */
  95 struct mii_softc {
  96         device_t mii_dev;               /* generic device glue */
  97
  98         LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */
  99
 100         uint32_t mii_mpd_oui;           /* the PHY's OUI (MII_OUI())*/
 101         uint32_t mii_mpd_model;         /* the PHY's model (MII_MODEL())*/
 102         uint32_t mii_mpd_rev;           /* the PHY's revision (MII_REV())*/
 103         u_int mii_capmask;              /* capability mask for BMSR */
 104         u_int mii_phy;                  /* our MII address */
 105         u_int mii_offset;               /* first PHY, second PHY, etc. */
 106         u_int mii_inst;                 /* instance for ifmedia */
 107
 108         /* Our PHY functions. */
 109         const struct mii_phy_funcs *mii_funcs;
 110
 111         struct mii_data *mii_pdata;     /* pointer to parent's mii_data */
 112
 113         u_int mii_flags;                /* misc. flags; see below */
 114         u_int mii_capabilities;         /* capabilities from BMSR */
 115         u_int mii_extcapabilities;      /* extended capabilities */
 116         u_int mii_ticks;                /* MII_TICK counter */
 117         u_int mii_anegticks;            /* ticks before retrying aneg */
 118         u_int mii_media_active;         /* last active media */
 119         u_int mii_media_status;         /* last active status */
 120 };
 121 typedef struct mii_softc mii_softc_t;
 122
 123 /* mii_flags */
 124 #define MIIF_INITDONE   0x00000001      /* has been initialized (mii_data) */
 125 #define MIIF_NOISOLATE  0x00000002      /* do not isolate the PHY */
 126 #if 0
 127 #define MIIF_NOLOOP     0x00000004      /* no loopback capability */
 128 #endif
 129 #define MIIF_DOINGAUTO  0x00000008      /* doing autonegotiation (mii_softc) */
 130 #define MIIF_AUTOTSLEEP 0x00000010      /* use tsleep(), not callout() */
 131 #define MIIF_HAVEFIBER  0x00000020      /* from parent: has fiber interface */
 132 #define MIIF_HAVE_GTCR  0x00000040      /* has 100base-T2/1000base-T CR */
 133 #define MIIF_IS_1000X   0x00000080      /* is a 1000BASE-X device */
 134 #define MIIF_DOPAUSE    0x00000100      /* advertise PAUSE capability */
 135 #define MIIF_IS_HPNA    0x00000200      /* is a HomePNA device */
 136 #define MIIF_FORCEANEG  0x00000400      /* force auto-negotiation */
 137 #define MIIF_NOMANPAUSE 0x00100000      /* no manual PAUSE selection */
 138 #define MIIF_FORCEPAUSE 0x00200000      /* force PAUSE advertisement */
 139 #define MIIF_MACPRIV0   0x01000000      /* private to the MAC driver */
 140 #define MIIF_MACPRIV1   0x02000000      /* private to the MAC driver */
 141 #define MIIF_MACPRIV2   0x04000000      /* private to the MAC driver */
 142 #define MIIF_PHYPRIV0   0x10000000      /* private to the PHY driver */
 143 #define MIIF_PHYPRIV1   0x20000000      /* private to the PHY driver */
 144 #define MIIF_PHYPRIV2   0x40000000      /* private to the PHY driver */
 145
 146 /* Default mii_anegticks values */
 147 #define MII_ANEGTICKS           5
 148 #define MII_ANEGTICKS_GIGE      17
 149
 150 #define MIIF_INHERIT_MASK       (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP)
 151
 152 /*
 153  * Special `locators' passed to mii_attach().  If one of these is not
 154  * an `any' value, we look for *that* PHY and configure it.  If both
 155  * are not `any', that is an error, and mii_attach() will fail.
 156  */
 157 #define MII_OFFSET_ANY          -1
 158 #define MII_PHY_ANY             -1
 159
 160 /*
 161  * Constants used to describe the type of attachment between MAC and PHY.
 162  */
 163 enum mii_contype {
 164         MII_CONTYPE_UNKNOWN,    /* Must be have value 0. */
 165
 166         MII_CONTYPE_MII,
 167         MII_CONTYPE_GMII,
 168         MII_CONTYPE_SGMII,
 169         MII_CONTYPE_QSGMII,
 170         MII_CONTYPE_TBI,
 171         MII_CONTYPE_REVMII,     /* Reverse MII */
 172         MII_CONTYPE_RMII,
 173         MII_CONTYPE_RGMII,      /* Delays provided by MAC or PCB */
 174         MII_CONTYPE_RGMII_ID,   /* Rx and tx delays provided by PHY */
 175         MII_CONTYPE_RGMII_RXID, /* Only rx delay provided by PHY */
 176         MII_CONTYPE_RGMII_TXID, /* Only tx delay provided by PHY */
 177         MII_CONTYPE_RTBI,
 178         MII_CONTYPE_SMII,
 179         MII_CONTYPE_XGMII,
 180         MII_CONTYPE_TRGMII,
 181         MII_CONTYPE_2000BX,
 182         MII_CONTYPE_2500BX,
 183         MII_CONTYPE_RXAUI,
 184
 185         MII_CONTYPE_COUNT       /* Add new types before this line. */
 186 };
 187 typedef enum mii_contype mii_contype_t;
 188
 189 static inline bool
 190 mii_contype_is_rgmii(mii_contype_t con)
 191 {
 192
 193         return (con >= MII_CONTYPE_RGMII && con <= MII_CONTYPE_RGMII_TXID);
 194 }
 195
 196 /*
 197  * Used to attach a PHY to a parent.
 198  */
 199 struct mii_attach_args {
 200         struct mii_data *mii_data;      /* pointer to parent data */
 201         u_int mii_phyno;                /* MII address */
 202         u_int mii_offset;               /* first PHY, second PHY, etc. */
 203         uint32_t mii_id1;               /* PHY ID register 1 */
 204         uint32_t mii_id2;               /* PHY ID register 2 */
 205         u_int mii_capmask;              /* capability mask for BMSR */
 206 };
 207 typedef struct mii_attach_args mii_attach_args_t;
 208
 209 /*
 210  * Used to match a PHY.
 211  */
 212 struct mii_phydesc {
 213         uint32_t mpd_oui;               /* the PHY's OUI */
 214         uint32_t mpd_model;             /* the PHY's model */
 215         const char *mpd_name;           /* the PHY's name */
 216 };
 217 #define MII_PHY_DESC(a, b) { MII_OUI_ ## a, MII_MODEL_ ## a ## _ ## b, \
 218         MII_STR_ ## a ## _ ## b }
 219 #define MII_PHY_END     { 0, 0, NULL }
 220
 221 #ifdef _KERNEL
 222
 223 #define PHY_READ(p, r) \
 224         MIIBUS_READREG((p)->mii_dev, (p)->mii_phy, (r))
 225
 226 #define PHY_WRITE(p, r, v) \
 227         MIIBUS_WRITEREG((p)->mii_dev, (p)->mii_phy, (r), (v))
 228
 229 #define PHY_SERVICE(p, d, o) \
 230         (*(p)->mii_funcs->pf_service)((p), (d), (o))
 231
 232 #define PHY_STATUS(p) \
 233         (*(p)->mii_funcs->pf_status)(p)
 234
 235 #define PHY_RESET(p) \
 236         (*(p)->mii_funcs->pf_reset)(p)
 237
 238 enum miibus_device_ivars {
 239         MIIBUS_IVAR_FLAGS
 240 };
 241
 242 /*
 243  * Simplified accessors for miibus
 244  */
 245 #define MIIBUS_ACCESSOR(var, ivar, type)                                \
 246         __BUS_ACCESSOR(miibus, var, MIIBUS, ivar, type)
 247
 248 MIIBUS_ACCESSOR(flags,          FLAGS,          u_int)
 249
 250 extern devclass_t       miibus_devclass;
 251 extern driver_t         miibus_driver;
 252
 253 int     mii_attach(device_t, device_t *, if_t, ifm_change_cb_t,
 254             ifm_stat_cb_t, int, int, int, int);
 255 int     mii_mediachg(struct mii_data *);
 256 void    mii_tick(struct mii_data *);
 257 void    mii_pollstat(struct mii_data *);
 258 void    mii_phy_add_media(struct mii_softc *);
 259
 260 int     mii_phy_auto(struct mii_softc *);
 261 int     mii_phy_detach(device_t dev);
 262 u_int   mii_phy_flowstatus(struct mii_softc *);
 263 void    mii_phy_reset(struct mii_softc *);
 264 void    mii_phy_setmedia(struct mii_softc *sc);
 265 void    mii_phy_update(struct mii_softc *, int);
 266 int     mii_phy_tick(struct mii_softc *);
 267 int     mii_phy_mac_match(struct mii_softc *, const char *);
 268 int     mii_dev_mac_match(device_t, const char *);
 269 void    *mii_phy_mac_softc(struct mii_softc *);
 270 void    *mii_dev_mac_softc(device_t);
 271
 272 const struct mii_phydesc * mii_phy_match(const struct mii_attach_args *ma,
 273     const struct mii_phydesc *mpd);
 274 const struct mii_phydesc * mii_phy_match_gen(const struct mii_attach_args *ma,
 275     const struct mii_phydesc *mpd, size_t endlen);
 276 int mii_phy_dev_probe(device_t dev, const struct mii_phydesc *mpd, int mrv);
 277 void mii_phy_dev_attach(device_t dev, u_int flags,
 278     const struct mii_phy_funcs *mpf, int add_media);
 279
 280 void    ukphy_status(struct mii_softc *);
 281
 282 u_int   mii_oui(u_int, u_int);
 283 #define MII_OUI(id1, id2)       mii_oui(id1, id2)
 284 #define MII_MODEL(id2)          (((id2) & IDR2_MODEL) >> 4)
 285 #define MII_REV(id2)            ((id2) & IDR2_REV)
 286
 287 #endif /* _KERNEL */
 288
 289 #endif /* _DEV_MII_MIIVAR_H_ */