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