sys/dev/netif/mii_layer/miivar.h

   1 /*      $NetBSD: miivar.h,v 1.8 1999/04/23 04:24:32 thorpej Exp $       */
   2
   3 /*-
   4  * Copyright (c) 1998, 1999 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.2 2003/06/17 04:28:28 dillon 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  * Callbacks from MII layer into network interface device driver.
  59  */
  60 typedef int (*mii_readreg_t) __P((struct device *, int, int));
  61 typedef void (*mii_writereg_t) __P((struct device *, int, int, int));
  62 typedef void (*mii_statchg_t) __P((struct device *));
  63
  64 /*
  65  * A network interface driver has one of these structures in its softc.
  66  * It is the interface from the network interface driver to the MII
  67  * layer.
  68  */
  69 struct mii_data {
  70         struct ifmedia mii_media;       /* media information */
  71         struct ifnet *mii_ifp;          /* pointer back to network interface */
  72
  73         /*
  74          * For network interfaces with multiple PHYs, a list of all
  75          * PHYs is required so they can all be notified when a media
  76          * request is made.
  77          */
  78         LIST_HEAD(mii_listhead, mii_softc) mii_phys;
  79         int mii_instance;
  80
  81         /*
  82          * PHY driver fills this in with active media status.
  83          */
  84         int mii_media_status;
  85         int mii_media_active;
  86
  87         /*
  88          * Calls from MII layer into network interface driver.
  89          */
  90         mii_readreg_t mii_readreg;
  91         mii_writereg_t mii_writereg;
  92         mii_statchg_t mii_statchg;
  93 };
  94 typedef struct mii_data mii_data_t;
  95
  96 /*
  97  * This call is used by the MII layer to call into the PHY driver
  98  * to perform a `service request'.
  99  */
 100 typedef int (*mii_downcall_t) __P((struct mii_softc *, struct mii_data *, int));
 101
 102 /*
 103  * Requests that can be made to the downcall.
 104  */
 105 #define MII_TICK        1       /* once-per-second tick */
 106 #define MII_MEDIACHG    2       /* user changed media; perform the switch */
 107 #define MII_POLLSTAT    3       /* user requested media status; fill it in */
 108
 109 /*
 110  * Each PHY driver's softc has one of these as the first member.
 111  * XXX This would be better named "phy_softc", but this is the name
 112  * XXX BSDI used, and we would like to have the same interface.
 113  */
 114 struct mii_softc {
 115         device_t mii_dev;               /* generic device glue */
 116
 117         LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */
 118
 119         int mii_phy;                    /* our MII address */
 120         int mii_inst;                   /* instance for ifmedia */
 121
 122         mii_downcall_t mii_service;     /* our downcall */
 123         struct mii_data *mii_pdata;     /* pointer to parent's mii_data */
 124         struct callout_handle mii_auto_ch; /* callout handle for phy autoneg */
 125
 126         int mii_flags;                  /* misc. flags; see below */
 127         int mii_capabilities;           /* capabilities from BMSR */
 128         int mii_ticks;                  /* MII_TICK counter */
 129         int mii_active;                 /* last active media */
 130 };
 131 typedef struct mii_softc mii_softc_t;
 132
 133 /* mii_flags */
 134 #define MIIF_NOISOLATE  0x0001          /* do not isolate the PHY */
 135 #define MIIF_DOINGAUTO  0x0002          /* doing autonegotiation */
 136
 137 /*
 138  * Used to attach a PHY to a parent.
 139  */
 140 struct mii_attach_args {
 141         struct mii_data *mii_data;      /* pointer to parent data */
 142         int mii_phyno;                  /* MII address */
 143         int mii_id1;                    /* PHY ID register 1 */
 144         int mii_id2;                    /* PHY ID register 2 */
 145         int mii_capmask;                /* capability mask from BMSR */
 146 };
 147 typedef struct mii_attach_args mii_attach_args_t;
 148
 149 #ifdef _KERNEL
 150
 151 #define PHY_READ(p, r) \
 152         MIIBUS_READREG((p)->mii_dev, (p)->mii_phy, (r))
 153
 154 #define PHY_WRITE(p, r, v) \
 155         MIIBUS_WRITEREG((p)->mii_dev, (p)->mii_phy, (r), (v))
 156
 157 extern devclass_t       miibus_devclass;
 158 extern driver_t         miibus_driver;
 159
 160 int     miibus_probe __P((device_t));
 161 int     miibus_attach __P((device_t));
 162 int     miibus_detach __P((device_t));
 163
 164 int     mii_anar __P((int));
 165 int     mii_mediachg __P((struct mii_data *));
 166 void    mii_tick __P((struct mii_data *));
 167 void    mii_pollstat __P((struct mii_data *));
 168 int     mii_phy_probe __P((device_t, device_t *,
 169             ifm_change_cb_t, ifm_stat_cb_t));
 170 void    mii_add_media __P((struct mii_data *, int, int));
 171
 172 int     mii_media_from_bmcr __P((int));
 173
 174 int     mii_phy_auto __P((struct mii_softc *, int));
 175 void    mii_phy_auto_stop __P((struct mii_softc *));
 176 void    mii_phy_reset __P((struct mii_softc *));
 177
 178 void    ukphy_status __P((struct mii_softc *));
 179 #endif /* _KERNEL */
 180
 181 #endif /* _DEV_MII_MIIVAR_H_ */