Home | History | Annotate | Line # | Download | only in mii
miivar.h revision 1.14
      1 /*	$NetBSD: miivar.h,v 1.14 2000/02/02 08:05:33 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 
     49 struct mii_softc;
     50 
     51 /*
     52  * Callbacks from MII layer into network interface device driver.
     53  */
     54 typedef	int (*mii_readreg_t) __P((struct device *, int, int));
     55 typedef	void (*mii_writereg_t) __P((struct device *, int, int, int));
     56 typedef	void (*mii_statchg_t) __P((struct device *));
     57 
     58 /*
     59  * A network interface driver has one of these structures in its softc.
     60  * It is the interface from the network interface driver to the MII
     61  * layer.
     62  */
     63 struct mii_data {
     64 	struct ifmedia mii_media;	/* media information */
     65 	struct ifnet *mii_ifp;		/* pointer back to network interface */
     66 
     67 	int mii_flags;			/* misc. flags; see below */
     68 
     69 	/*
     70 	 * For network interfaces with multiple PHYs, a list of all
     71 	 * PHYs is required so they can all be notified when a media
     72 	 * request is made.
     73 	 */
     74 	LIST_HEAD(mii_listhead, mii_softc) mii_phys;
     75 	int mii_instance;
     76 
     77 	/*
     78 	 * PHY driver fills this in with active media status.
     79 	 */
     80 	int mii_media_status;
     81 	int mii_media_active;
     82 
     83 	/*
     84 	 * Calls from MII layer into network interface driver.
     85 	 */
     86 	mii_readreg_t mii_readreg;
     87 	mii_writereg_t mii_writereg;
     88 	mii_statchg_t mii_statchg;
     89 };
     90 typedef struct mii_data mii_data_t;
     91 
     92 /*
     93  * This call is used by the MII layer to call into the PHY driver
     94  * to perform a `service request'.
     95  */
     96 typedef	int (*mii_downcall_t) __P((struct mii_softc *, struct mii_data *, int));
     97 
     98 /*
     99  * Requests that can be made to the downcall.
    100  */
    101 #define	MII_TICK	1	/* once-per-second tick */
    102 #define	MII_MEDIACHG	2	/* user changed media; perform the switch */
    103 #define	MII_POLLSTAT	3	/* user requested media status; fill it in */
    104 #define	MII_DOWN	4	/* interface is down */
    105 
    106 /*
    107  * Each PHY driver's softc has one of these as the first member.
    108  * XXX This would be better named "phy_softc", but this is the name
    109  * XXX BSDI used, and we would like to have the same interface.
    110  */
    111 struct mii_softc {
    112 	struct device mii_dev;		/* generic device glue */
    113 
    114 	LIST_ENTRY(mii_softc) mii_list;	/* entry on parent's PHY list */
    115 
    116 	int mii_phy;			/* our MII address */
    117 	int mii_offset;			/* first PHY, second PHY, etc. */
    118 	int mii_inst;			/* instance for ifmedia */
    119 
    120 	mii_downcall_t mii_service;	/* our downcall */
    121 	struct mii_data *mii_pdata;	/* pointer to parent's mii_data */
    122 
    123 	int mii_flags;			/* misc. flags; see below */
    124 	int mii_capabilities;		/* capabilities from BMSR */
    125 	int mii_ticks;			/* MII_TICK counter */
    126 	int mii_active;			/* last active media */
    127 };
    128 typedef struct mii_softc mii_softc_t;
    129 
    130 /* mii_flags */
    131 #define	MIIF_INITDONE	0x0001		/* has been initialized (mii_data) */
    132 #define	MIIF_NOISOLATE	0x0002		/* do not isolate the PHY */
    133 #define	MIIF_NOLOOP	0x0004		/* no loopback capability */
    134 #define	MIIF_DOINGAUTO	0x0008		/* doing autonegotiation (mii_softc) */
    135 
    136 #define	MIIF_INHERIT_MASK	(MIIF_NOISOLATE|MIIF_NOLOOP)
    137 
    138 /*
    139  * Special `locators' passed to mii_attach().  If one of these is not
    140  * an `any' value, we look for *that* PHY and configure it.  If both
    141  * are not `any', that is an error, and mii_attach() will panic.
    142  */
    143 #define	MII_OFFSET_ANY		-1
    144 #define	MII_PHY_ANY		-1
    145 
    146 /*
    147  * Used to attach a PHY to a parent.
    148  */
    149 struct mii_attach_args {
    150 	struct mii_data *mii_data;	/* pointer to parent data */
    151 	int mii_phyno;			/* MII address */
    152 	int mii_id1;			/* PHY ID register 1 */
    153 	int mii_id2;			/* PHY ID register 2 */
    154 	int mii_capmask;		/* capability mask from BMSR */
    155 };
    156 typedef struct mii_attach_args mii_attach_args_t;
    157 
    158 /*
    159  * An array of these structures map MII media types to BMCR/ANAR settings.
    160  */
    161 struct mii_media {
    162 	int	mm_bmcr;		/* BMCR settings for this media */
    163 	int	mm_anar;		/* ANAR settings for this media */
    164 };
    165 
    166 #define	MII_MEDIA_NONE		0
    167 #define	MII_MEDIA_10_T		1
    168 #define	MII_MEDIA_10_T_FDX	2
    169 #define	MII_MEDIA_100_T4	3
    170 #define	MII_MEDIA_100_TX	4
    171 #define	MII_MEDIA_100_TX_FDX	5
    172 #define	MII_NMEDIA		6
    173 
    174 #ifdef _KERNEL
    175 #include "locators.h"
    176 
    177 #define	PHY_READ(p, r) \
    178 	(*(p)->mii_pdata->mii_readreg)((p)->mii_dev.dv_parent, \
    179 	    (p)->mii_phy, (r))
    180 
    181 #define	PHY_WRITE(p, r, v) \
    182 	(*(p)->mii_pdata->mii_writereg)((p)->mii_dev.dv_parent, \
    183 	    (p)->mii_phy, (r), (v))
    184 
    185 void	mii_attach __P((struct device *, struct mii_data *, int, int, int));
    186 void	mii_activate __P((struct mii_data *, enum devact, int, int));
    187 void	mii_detach __P((struct mii_data *, int, int));
    188 
    189 int	mii_mediachg __P((struct mii_data *));
    190 void	mii_tick __P((struct mii_data *));
    191 void	mii_pollstat __P((struct mii_data *));
    192 void	mii_down __P((struct mii_data *));
    193 
    194 int	mii_phy_activate __P((struct device *, enum devact));
    195 int	mii_phy_detach __P((struct device *, int));
    196 
    197 void	mii_phy_add_media __P((struct mii_softc *));
    198 void	mii_phy_delete_media __P((struct mii_softc *));
    199 
    200 void	mii_phy_setmedia __P((struct mii_softc *));
    201 int	mii_phy_auto __P((struct mii_softc *, int));
    202 void	mii_phy_reset __P((struct mii_softc *));
    203 void	mii_phy_down __P((struct mii_softc *));
    204 
    205 void	ukphy_status __P((struct mii_softc *));
    206 #endif /* _KERNEL */
    207 
    208 #endif /* _DEV_MII_MIIVAR_H_ */
    209