Home | History | Annotate | Line # | Download | only in mii
miivar.h revision 1.12
      1 /*	$NetBSD: miivar.h,v 1.12 1999/11/12 18:13:00 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 
     40 #ifndef _DEV_MII_MIIVAR_H_
     41 #define	_DEV_MII_MIIVAR_H_
     42 
     43 #include <sys/queue.h>
     44 
     45 /*
     46  * Media Independent Interface autoconfiguration defintions.
     47  *
     48  * This file exports an interface which attempts to be compatible
     49  * with the BSD/OS 3.0 interface.
     50  */
     51 
     52 struct mii_softc;
     53 
     54 /*
     55  * Callbacks from MII layer into network interface device driver.
     56  */
     57 typedef	int (*mii_readreg_t) __P((struct device *, int, int));
     58 typedef	void (*mii_writereg_t) __P((struct device *, int, int, int));
     59 typedef	void (*mii_statchg_t) __P((struct device *));
     60 
     61 /*
     62  * A network interface driver has one of these structures in its softc.
     63  * It is the interface from the network interface driver to the MII
     64  * layer.
     65  */
     66 struct mii_data {
     67 	struct ifmedia mii_media;	/* media information */
     68 	struct ifnet *mii_ifp;		/* pointer back to network interface */
     69 
     70 	int mii_flags;			/* misc. flags; see below */
     71 
     72 	/*
     73 	 * For network interfaces with multiple PHYs, a list of all
     74 	 * PHYs is required so they can all be notified when a media
     75 	 * request is made.
     76 	 */
     77 	LIST_HEAD(mii_listhead, mii_softc) mii_phys;
     78 	int mii_instance;
     79 
     80 	/*
     81 	 * PHY driver fills this in with active media status.
     82 	 */
     83 	int mii_media_status;
     84 	int mii_media_active;
     85 
     86 	/*
     87 	 * Calls from MII layer into network interface driver.
     88 	 */
     89 	mii_readreg_t mii_readreg;
     90 	mii_writereg_t mii_writereg;
     91 	mii_statchg_t mii_statchg;
     92 };
     93 typedef struct mii_data mii_data_t;
     94 
     95 /*
     96  * This call is used by the MII layer to call into the PHY driver
     97  * to perform a `service request'.
     98  */
     99 typedef	int (*mii_downcall_t) __P((struct mii_softc *, struct mii_data *, int));
    100 
    101 /*
    102  * Requests that can be made to the downcall.
    103  */
    104 #define	MII_TICK	1	/* once-per-second tick */
    105 #define	MII_MEDIACHG	2	/* user changed media; perform the switch */
    106 #define	MII_POLLSTAT	3	/* user requested media status; fill it in */
    107 #define	MII_DOWN	4	/* interface is down */
    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 	struct device 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_offset;			/* first PHY, second PHY, etc. */
    121 	int mii_inst;			/* instance for ifmedia */
    122 
    123 	mii_downcall_t mii_service;	/* our downcall */
    124 	struct mii_data *mii_pdata;	/* pointer to parent's mii_data */
    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_INITDONE	0x0001		/* has been initialized (mii_data) */
    135 #define	MIIF_NOISOLATE	0x0002		/* do not isolate the PHY */
    136 #define	MIIF_NOLOOP	0x0004		/* no loopback capability */
    137 #define	MIIF_DOINGAUTO	0x0008		/* doing autonegotiation (mii_softc) */
    138 
    139 #define	MIIF_INHERIT_MASK	(MIIF_NOISOLATE|MIIF_NOLOOP)
    140 
    141 /*
    142  * Special `locators' passed to mii_phy_probe.  If one of these is not
    143  * an `any' value, we look for *that* PHY and configure it.  If both
    144  * are not `any', that is an error, and mii_phy_probe() will panic.
    145  */
    146 #define	MII_OFFSET_ANY		-1
    147 #define	MII_PHY_ANY		-1
    148 
    149 /*
    150  * Used to attach a PHY to a parent.
    151  */
    152 struct mii_attach_args {
    153 	struct mii_data *mii_data;	/* pointer to parent data */
    154 	int mii_phyno;			/* MII address */
    155 	int mii_id1;			/* PHY ID register 1 */
    156 	int mii_id2;			/* PHY ID register 2 */
    157 	int mii_capmask;		/* capability mask from BMSR */
    158 };
    159 typedef struct mii_attach_args mii_attach_args_t;
    160 
    161 /*
    162  * An array of these structures map MII media types to BMCR/ANAR settings.
    163  */
    164 struct mii_media {
    165 	int	mm_bmcr;		/* BMCR settings for this media */
    166 	int	mm_anar;		/* ANAR settings for this media */
    167 };
    168 
    169 #define	MII_MEDIA_NONE		0
    170 #define	MII_MEDIA_10_T		1
    171 #define	MII_MEDIA_10_T_FDX	2
    172 #define	MII_MEDIA_100_T4	3
    173 #define	MII_MEDIA_100_TX	4
    174 #define	MII_MEDIA_100_TX_FDX	5
    175 #define	MII_NMEDIA		6
    176 
    177 #ifdef _KERNEL
    178 #include "locators.h"
    179 
    180 #define	PHY_READ(p, r) \
    181 	(*(p)->mii_pdata->mii_readreg)((p)->mii_dev.dv_parent, \
    182 	    (p)->mii_phy, (r))
    183 
    184 #define	PHY_WRITE(p, r, v) \
    185 	(*(p)->mii_pdata->mii_writereg)((p)->mii_dev.dv_parent, \
    186 	    (p)->mii_phy, (r), (v))
    187 
    188 int	mii_mediachg __P((struct mii_data *));
    189 void	mii_tick __P((struct mii_data *));
    190 void	mii_pollstat __P((struct mii_data *));
    191 void	mii_down __P((struct mii_data *));
    192 void	mii_phy_probe __P((struct device *, struct mii_data *, int, int, int));
    193 void	mii_add_media __P((struct mii_softc *));
    194 
    195 void	mii_phy_setmedia __P((struct mii_softc *));
    196 int	mii_phy_auto __P((struct mii_softc *, int));
    197 void	mii_phy_reset __P((struct mii_softc *));
    198 void	mii_phy_down __P((struct mii_softc *));
    199 
    200 void	ukphy_status __P((struct mii_softc *));
    201 #endif /* _KERNEL */
    202 
    203 #endif /* _DEV_MII_MIIVAR_H_ */
    204