miivar.h revision 1.17 1 /* $NetBSD: miivar.h,v 1.17 2000/03/06 20:56:57 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
45 /*
46 * Media Independent Interface datat structure 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 * This is a call back into the PHY driver made by a `status request'.
100 */
101 typedef void (*mii_statusreq_t) __P((struct mii_softc *));
102
103 /*
104 * Requests that can be made to the downcall.
105 */
106 #define MII_TICK 1 /* once-per-second tick */
107 #define MII_MEDIACHG 2 /* user changed media; perform the switch */
108 #define MII_POLLSTAT 3 /* user requested media status; fill it in */
109 #define MII_DOWN 4 /* interface is down */
110
111 /*
112 * Each PHY driver's softc has one of these as the first member.
113 * XXX This would be better named "phy_softc", but this is the name
114 * XXX BSDI used, and we would like to have the same interface.
115 */
116 struct mii_softc {
117 struct device mii_dev; /* generic device glue */
118
119 LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */
120
121 int mii_phy; /* our MII address */
122 int mii_offset; /* first PHY, second PHY, etc. */
123 int mii_inst; /* instance for ifmedia */
124
125 mii_downcall_t mii_service; /* our downcall */
126 mii_statusreq_t mii_status; /* our status request fn */
127 struct mii_data *mii_pdata; /* pointer to parent's mii_data */
128
129 int mii_flags; /* misc. flags; see below */
130 int mii_capabilities; /* capabilities from BMSR */
131 int mii_ticks; /* MII_TICK counter */
132 int mii_media_active; /* last active media */
133 int mii_media_status; /* last active status */
134 };
135 typedef struct mii_softc mii_softc_t;
136
137 /* mii_flags */
138 #define MIIF_INITDONE 0x0001 /* has been initialized (mii_data) */
139 #define MIIF_NOISOLATE 0x0002 /* do not isolate the PHY */
140 #define MIIF_NOLOOP 0x0004 /* no loopback capability */
141 #define MIIF_DOINGAUTO 0x0008 /* doing autonegotiation (mii_softc) */
142
143 #define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP)
144
145 /*
146 * Special `locators' passed to mii_attach(). If one of these is not
147 * an `any' value, we look for *that* PHY and configure it. If both
148 * are not `any', that is an error, and mii_attach() will panic.
149 */
150 #define MII_OFFSET_ANY -1
151 #define MII_PHY_ANY -1
152
153 /*
154 * Used to attach a PHY to a parent.
155 */
156 struct mii_attach_args {
157 struct mii_data *mii_data; /* pointer to parent data */
158 int mii_phyno; /* MII address */
159 int mii_id1; /* PHY ID register 1 */
160 int mii_id2; /* PHY ID register 2 */
161 int mii_capmask; /* capability mask from BMSR */
162 int mii_flags; /* flags from parent */
163 };
164 typedef struct mii_attach_args mii_attach_args_t;
165
166 /*
167 * An array of these structures map MII media types to BMCR/ANAR settings.
168 */
169 struct mii_media {
170 int mm_bmcr; /* BMCR settings for this media */
171 int mm_anar; /* ANAR settings for this media */
172 };
173
174 #define MII_MEDIA_NONE 0
175 #define MII_MEDIA_10_T 1
176 #define MII_MEDIA_10_T_FDX 2
177 #define MII_MEDIA_100_T4 3
178 #define MII_MEDIA_100_TX 4
179 #define MII_MEDIA_100_TX_FDX 5
180 #define MII_NMEDIA 6
181
182 #ifdef _KERNEL
183 #include "locators.h"
184
185 #define PHY_READ(p, r) \
186 (*(p)->mii_pdata->mii_readreg)((p)->mii_dev.dv_parent, \
187 (p)->mii_phy, (r))
188
189 #define PHY_WRITE(p, r, v) \
190 (*(p)->mii_pdata->mii_writereg)((p)->mii_dev.dv_parent, \
191 (p)->mii_phy, (r), (v))
192
193 void mii_attach __P((struct device *, struct mii_data *, int, int,
194 int, int));
195 void mii_activate __P((struct mii_data *, enum devact, int, int));
196 void mii_detach __P((struct mii_data *, int, int));
197
198 int mii_mediachg __P((struct mii_data *));
199 void mii_tick __P((struct mii_data *));
200 void mii_pollstat __P((struct mii_data *));
201 void mii_down __P((struct mii_data *));
202
203 int mii_phy_activate __P((struct device *, enum devact));
204 int mii_phy_detach __P((struct device *, int));
205
206 void mii_phy_add_media __P((struct mii_softc *));
207 void mii_phy_delete_media __P((struct mii_softc *));
208
209 void mii_phy_setmedia __P((struct mii_softc *));
210 int mii_phy_auto __P((struct mii_softc *, int));
211 void mii_phy_reset __P((struct mii_softc *));
212 void mii_phy_down __P((struct mii_softc *));
213 int mii_phy_tick __P((struct mii_softc *));
214
215 void mii_phy_status __P((struct mii_softc *));
216 void mii_phy_update __P((struct mii_softc *, int));
217 void mii_phy_statusmsg __P((struct mii_softc *));
218
219 void ukphy_status __P((struct mii_softc *));
220 #endif /* _KERNEL */
221
222 #endif /* _DEV_MII_MIIVAR_H_ */
223