miivar.h revision 1.3 
1/*	$OpenBSD: miivar.h,v 1.3 1999/07/16 14:59:07 jason Exp $	*/
2/*	$NetBSD: miivar.h,v 1.7.6.1 1999/04/23 15:40:35 perry Exp $	*/
3
4/*-
5 * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
6 * All rights reserved.
7 *
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
10 * NASA Ames Research Center.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 *    notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 *    notice, this list of conditions and the following disclaimer in the
19 *    documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 *    must display the following acknowledgement:
22 *	This product includes software developed by the NetBSD
23 *	Foundation, Inc. and its contributors.
24 * 4. Neither the name of The NetBSD Foundation nor the names of its
25 *    contributors may be used to endorse or promote products derived
26 *    from this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 * POSSIBILITY OF SUCH DAMAGE.
39 */
40
41#ifndef _DEV_MII_MIIVAR_H_
42#define	_DEV_MII_MIIVAR_H_
43
44#include <sys/queue.h>
45
46/*
47 * Media Independent Interface autoconfiguration defintions.
48 *
49 * This file exports an interface which attempts to be compatible
50 * with the BSD/OS 3.0 interface.
51 */
52
53struct mii_softc;
54
55/*
56 * Callbacks from MII layer into network interface device driver.
57 */
58typedef	int (*mii_readreg_t) __P((struct device *, int, int));
59typedef	void (*mii_writereg_t) __P((struct device *, int, int, int));
60typedef	void (*mii_statchg_t) __P((struct device *));
61
62/*
63 * A network interface driver has one of these structures in its softc.
64 * It is the interface from the network interface driver to the MII
65 * layer.
66 */
67struct mii_data {
68	struct ifmedia mii_media;	/* media information */
69	struct ifnet *mii_ifp;		/* pointer back to network interface */
70
71	/*
72	 * For network interfaces with multiple PHYs, a list of all
73	 * PHYs is required so they can all be notified when a media
74	 * request is made.
75	 */
76	LIST_HEAD(mii_listhead, mii_softc) mii_phys;
77	int mii_instance;
78
79	/*
80	 * PHY driver fills this in with active media status.
81	 */
82	int mii_media_status;
83	int mii_media_active;
84
85	/*
86	 * Calls from MII layer into network interface driver.
87	 */
88	mii_readreg_t mii_readreg;
89	mii_writereg_t mii_writereg;
90	mii_statchg_t mii_statchg;
91};
92typedef struct mii_data mii_data_t;
93
94/*
95 * This call is used by the MII layer to call into the PHY driver
96 * to perform a `service request'.
97 */
98typedef	int (*mii_downcall_t) __P((struct mii_softc *, struct mii_data *, int));
99
100/*
101 * Requests that can be made to the downcall.
102 */
103#define	MII_TICK	1	/* once-per-second tick */
104#define	MII_MEDIACHG	2	/* user changed media; perform the switch */
105#define	MII_POLLSTAT	3	/* user requested media status; fill it in */
106
107/*
108 * Each PHY driver's softc has one of these as the first member.
109 * XXX This would be better named "phy_softc", but this is the name
110 * XXX BSDI used, and we would like to have the same interface.
111 */
112struct mii_softc {
113	struct device mii_dev;		/* generic device glue */
114
115	LIST_ENTRY(mii_softc) mii_list;	/* entry on parent's PHY list */
116
117	int mii_phy;			/* our MII address */
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};
128typedef struct mii_softc mii_softc_t;
129
130/* mii_flags */
131#define	MIIF_NOISOLATE	0x0001		/* do not isolate the PHY */
132#define	MIIF_DOINGAUTO	0x0002		/* doing autonegotiation */
133
134/*
135 * Used to attach a PHY to a parent.
136 */
137struct mii_attach_args {
138	struct mii_data *mii_data;	/* pointer to parent data */
139	int mii_phyno;			/* MII address */
140	int mii_id1;			/* PHY ID register 1 */
141	int mii_id2;			/* PHY ID register 2 */
142	int mii_capmask;		/* capability mask from BMSR */
143};
144typedef struct mii_attach_args mii_attach_args_t;
145
146#ifdef _KERNEL
147
148#define	PHY_READ(p, r) \
149	(*(p)->mii_pdata->mii_readreg)((p)->mii_dev.dv_parent, \
150	    (p)->mii_phy, (r))
151
152#define	PHY_WRITE(p, r, v) \
153	(*(p)->mii_pdata->mii_writereg)((p)->mii_dev.dv_parent, \
154	    (p)->mii_phy, (r), (v))
155
156int	mii_anar __P((int));
157int	mii_mediachg __P((struct mii_data *));
158void	mii_tick __P((struct mii_data *));
159void	mii_pollstat __P((struct mii_data *));
160void	mii_phy_probe __P((struct device *, struct mii_data *, int));
161void	mii_add_media __P((struct mii_data *, int, int));
162
163int	mii_media_from_bmcr __P((int));
164
165int	mii_phy_auto __P((struct mii_softc *, int));
166void	mii_phy_reset __P((struct mii_softc *));
167
168void	ukphy_status __P((struct mii_softc *));
169#endif /* _KERNEL */
170
171#endif /* _DEV_MII_MIIVAR_H_ */
172