1 /* $NetBSD: miivar.h,v 1.75 2022/08/14 20:34:26 riastradh Exp $ */
2
3 /*-
4 * Copyright (c) 1998, 1999, 2000, 2001, 2020 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 *
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #ifndef _DEV_MII_MIIVAR_H_
34 #define _DEV_MII_MIIVAR_H_
35
36 #include <sys/queue.h>
37 #include <sys/callout.h>
38 #include <sys/condvar.h>
39
40 #include <dev/mii/mii.h>
41 #include <dev/mii/mii_verbose.h>
42
43 /*
44 * Media Independent Interface data structure definitions.
45 */
46
47 struct ifnet;
48 struct mii_softc;
49
50 /*
51 * Callbacks from MII layer into network interface device driver.
52 */
53 typedef int (*mii_readreg_t)(device_t, int, int, uint16_t *);
54 typedef int (*mii_writereg_t)(device_t, int, int, uint16_t);
55 typedef void (*mii_statchg_t)(struct ifnet *);
56
57 /*
58 * A network interface driver has one of these structures in its softc.
59 * It is the interface from the network interface driver to the MII
60 * layer.
61 *
62 * LOCKING
63 * =======
64 *
65 * The MII shares the lock with its ifmedia (which in turn shares the
66 * lock with its driver).
67 *
68 * MII routines can be called from a driver's interrupt handler, as well
69 * as via administrative input (e.g. ifmedia_ioctl()). We therefore require
70 * that most MII APIs are called with the ifmedia lock HELD. (See below.)
71 *
72 * Field markings and the corresponding locks:
73 *
74 * m: ifmedia lock
75 * :: unlocked, stable
76 */
77 struct mii_data {
78 struct ifmedia mii_media; /* m: media information */
79 struct ifnet *mii_ifp; /* :: pointer back to interface */
80
81 kcondvar_t mii_probe_cv; /* m: serialize probing the MII */
82 u_int mii_probe_waiters; /* m: # threads waiting to probe */
83 int mii_flags; /* m: misc. flags; see below */
84
85 /*
86 * m: For network interfaces with multiple PHYs, a list of all
87 * PHYs is required so they can all be notified when a media
88 * request is made.
89 */
90 LIST_HEAD(mii_listhead, mii_softc) mii_phys;
91 u_int mii_instance;
92
93 /* m: PHY driver fills this in with active media status. */
94 int mii_media_status;
95 u_int mii_media_active;
96
97 /* :: Calls from MII layer into network interface driver. */
98 mii_readreg_t mii_readreg;
99 mii_writereg_t mii_writereg;
100 mii_statchg_t mii_statchg;
101 };
102 typedef struct mii_data mii_data_t;
103
104 #define mii_lock(mii) ifmedia_lock(&(mii)->mii_media)
105 #define mii_unlock(mii) ifmedia_unlock(&(mii)->mii_media)
106 #define mii_locked(mii) ifmedia_locked(&(mii)->mii_media)
107
108 /*
109 * Functions provided by the PHY to perform various functions.
110 */
111 struct mii_phy_funcs {
112 int (*pf_service)(struct mii_softc *, struct mii_data *, int);
113 void (*pf_status)(struct mii_softc *);
114 void (*pf_reset)(struct mii_softc *);
115 };
116
117 /*
118 * Requests that can be made to the downcall.
119 */
120 #define MII_TICK 1 /* once-per-second tick */
121 #define MII_MEDIACHG 2 /* user changed media; perform the switch */
122 #define MII_POLLSTAT 3 /* user requested media status; fill it in */
123 #define MII_DOWN 4 /* interface is down */
124
125 /*
126 * Each PHY driver's softc has one of these as the first member.
127 * XXX This would be better named "phy_softc", but this is the name
128 * XXX BSDI used, and we would like to have the same interface.
129 */
130 struct mii_softc {
131 device_t mii_dev; /* generic device glue */
132
133 LIST_ENTRY(mii_softc) mii_list; /* m: entry on parent's PHY list */
134
135 uint32_t mii_mpd_oui; /* :: the PHY's OUI (MII_OUI())*/
136 uint32_t mii_mpd_model; /* :: the PHY's model (MII_MODEL())*/
137 uint32_t mii_mpd_rev; /* :: the PHY's revision (MII_REV())*/
138 int mii_phy; /* :: our MII address */
139 int mii_offset; /* :: first PHY, second PHY, etc. */
140 u_int mii_inst; /* :: instance for ifmedia */
141
142 /* :: Our PHY functions. */
143 const struct mii_phy_funcs *mii_funcs;
144
145 struct mii_data *mii_pdata; /* :: pointer to parent's mii_data */
146
147 int mii_flags; /* m: misc. flags; see below */
148 uint16_t mii_capabilities; /* :: capabilities from BMSR */
149 uint16_t mii_extcapabilities; /* :: extended caps from EXTSR */
150 int mii_ticks; /* m: MII_TICK counter */
151 int mii_anegticks; /* m: ticks before retrying aneg */
152
153 union {
154 struct callout mii_nway_ch; /* m: NWAY callout */
155 kcondvar_t mii_nway_cv;
156 };
157
158 u_int mii_media_active; /* m: last active media */
159 int mii_media_status; /* m: last active status */
160 };
161 typedef struct mii_softc mii_softc_t;
162
163 /* Default mii_anegticks values. */
164 #define MII_ANEGTICKS 5
165 #define MII_ANEGTICKS_GIGE 10
166
167 /* mii_flags */
168 #define MIIF_INITDONE 0x0001 /* has been initialized (mii_data) */
169 #define MIIF_NOISOLATE 0x0002 /* do not isolate the PHY */
170 #define MIIF_NOLOOP 0x0004 /* no loopback capability */
171 #define MIIF_DOINGAUTO 0x0008 /* doing autonegotiation (mii_softc) */
172 #define MIIF_AUTOTSLEEP 0x0010 /* use kpause(), not callout() */
173 #define MIIF_HAVEFIBER 0x0020 /* from parent: has fiber interface */
174 #define MIIF_HAVE_GTCR 0x0040 /* has 100base-T2/1000base-T CR */
175 #define MIIF_IS_1000X 0x0080 /* is a 1000BASE-X device */
176 #define MIIF_DOPAUSE 0x0100 /* advertise PAUSE capability */
177 #define MIIF_IS_HPNA 0x0200 /* is a HomePNA device */
178 #define MIIF_FORCEANEG 0x0400 /* force auto-negotiation */
179 #define MIIF_PROBING 0x0800 /* PHY probe in-progress */
180 #define MIIF_EXITING 0x1000 /* MII is exiting */
181 #define MIIF_RXID 0x2000 /* add RX delay */
182 #define MIIF_TXID 0x4000 /* add TX delay */
183
184 #define MIIF_INHERIT_MASK (MIIF_NOISOLATE | MIIF_NOLOOP | MIIF_AUTOTSLEEP)
185
186 /*
187 * Special `locators' passed to mii_attach(). If one of these is not
188 * an `any' value, we look for *that* PHY and configure it. If both
189 * are not `any', that is an error, and mii_attach() will panic.
190 */
191 #define MII_OFFSET_ANY -1
192 #define MII_PHY_ANY -1
193
194 /*
195 * Used to attach a PHY to a parent.
196 */
197 struct mii_attach_args {
198 struct mii_data *mii_data; /* pointer to parent data */
199 int mii_phyno; /* MII address */
200 uint16_t mii_id1; /* PHY ID register 1 */
201 uint16_t mii_id2; /* PHY ID register 2 */
202 uint16_t mii_capmask; /* capability mask from BMSR */
203 int mii_flags; /* flags from parent */
204 };
205 typedef struct mii_attach_args mii_attach_args_t;
206
207 /*
208 * Used to match a PHY.
209 */
210 struct mii_phydesc {
211 uint32_t mpd_oui; /* the PHY's OUI */
212 uint32_t mpd_model; /* the PHY's model */
213 const char *mpd_name; /* the PHY's name */
214 };
215
216 #define MII_PHY_DESC(a, b) { MII_OUI_ ## a, MII_MODEL_ ## a ## _ ## b, \
217 MII_STR_ ## a ## _ ## b }
218 #define MII_PHY_END { 0, 0, NULL }
219
220 /*
221 * An array of these structures map MII media types to BMCR/ANAR settings.
222 */
223 struct mii_media {
224 uint16_t mm_bmcr; /* BMCR settings for this media */
225 uint16_t mm_anar; /* ANAR settings for this media */
226 uint16_t mm_gtcr; /* 100base-T2 or 1000base-T CR */
227 };
228
229 #define MII_MEDIA_NONE 0
230 #define MII_MEDIA_10_T 1
231 #define MII_MEDIA_10_T_FDX 2
232 #define MII_MEDIA_100_T4 3
233 #define MII_MEDIA_100_TX 4
234 #define MII_MEDIA_100_TX_FDX 5
235 #define MII_MEDIA_1000_X 6
236 #define MII_MEDIA_1000_X_FDX 7
237 #define MII_MEDIA_1000_T 8
238 #define MII_MEDIA_1000_T_FDX 9
239 #define MII_NMEDIA 10
240
241 #ifdef _KERNEL
242
243 #define PHY_READ(p, r, v) \
244 (*(p)->mii_pdata->mii_readreg)(device_parent((p)->mii_dev), \
245 (p)->mii_phy, (r), (v))
246
247 #define PHY_WRITE(p, r, v) \
248 (*(p)->mii_pdata->mii_writereg)(device_parent((p)->mii_dev), \
249 (p)->mii_phy, (r), (v))
250
251 /*
252 * Setup MDD indirect access. Set device address and register number.
253 * "addr" variable takes an address ORed with the function (MMDACR_FN_*).
254 *
255 */
256 static inline int
MMD_INDIRECT(struct mii_softc * sc,uint16_t daddr,uint16_t regnum)257 MMD_INDIRECT(struct mii_softc *sc, uint16_t daddr, uint16_t regnum)
258 {
259 int rv;
260
261 /*
262 * Set the MMD device address and set the access mode (function)
263 * to address.
264 */
265 if ((rv = PHY_WRITE(sc, MII_MMDACR, (daddr & ~MMDACR_FUNCMASK))) != 0)
266 return rv;
267
268 /* Set the register number */
269 if ((rv = PHY_WRITE(sc, MII_MMDAADR, regnum)) != 0)
270 return rv;
271
272 /* Set the access mode (function) */
273 rv = PHY_WRITE(sc, MII_MMDACR, daddr);
274
275 return rv;
276 }
277
278 static inline int
MMD_INDIRECT_READ(struct mii_softc * sc,uint16_t daddr,uint16_t regnum,uint16_t * valp)279 MMD_INDIRECT_READ(struct mii_softc *sc, uint16_t daddr, uint16_t regnum,
280 uint16_t *valp)
281 {
282 int rv;
283
284 if ((rv = MMD_INDIRECT(sc, daddr, regnum)) != 0)
285 return rv;
286
287 return PHY_READ(sc, MII_MMDAADR, valp);
288 }
289
290 static inline int
MMD_INDIRECT_WRITE(struct mii_softc * sc,uint16_t daddr,uint16_t regnum,uint16_t val)291 MMD_INDIRECT_WRITE(struct mii_softc *sc, uint16_t daddr, uint16_t regnum,
292 uint16_t val)
293 {
294 int rv;
295
296 if ((rv = MMD_INDIRECT(sc, daddr, regnum)) != 0)
297 return rv;
298
299 return PHY_WRITE(sc, MII_MMDAADR, val);
300 }
301
302 /* MII must be LOCKED. */
303 #define PHY_SERVICE(p, d, o) \
304 (*(p)->mii_funcs->pf_service)((p), (d), (o))
305 #define PHY_STATUS(p) \
306 (*(p)->mii_funcs->pf_status)((p))
307 #define PHY_RESET(p) \
308 (*(p)->mii_funcs->pf_reset)((p))
309
310 /* MII must be UNLOCKED */
311 void mii_attach(device_t, struct mii_data *, int, int, int, int);
312 void mii_detach(struct mii_data *, int, int);
313
314 /* MII must be LOCKED. */
315 int mii_mediachg(struct mii_data *);
316 void mii_tick(struct mii_data *);
317 void mii_pollstat(struct mii_data *);
318 void mii_down(struct mii_data *);
319 int mii_ifmedia_change(struct mii_data *);
320
321 uint16_t mii_anar(struct ifmedia_entry *);
322
323 /* MII must be UNLOCKED */
324 int mii_phy_activate(device_t, enum devact);
325 int mii_phy_detach(device_t, int);
326 bool mii_phy_resume(device_t, const pmf_qual_t *);
327
328 const struct mii_phydesc *mii_phy_match(const struct mii_attach_args *,
329 const struct mii_phydesc *);
330
331 /* MII must be UNLOCKED */
332 void mii_phy_add_media(struct mii_softc *);
333 void mii_phy_delete_media(struct mii_softc *);
334
335 /* MII must be LOCKED */
336 void mii_phy_setmedia(struct mii_softc *);
337 int mii_phy_auto(struct mii_softc *);
338 int mii_phy_auto_restart(struct mii_softc *);
339 void mii_phy_reset(struct mii_softc *);
340 void mii_phy_down(struct mii_softc *);
341 int mii_phy_tick(struct mii_softc *);
342
343 /* MII must be LOCKED */
344 void mii_phy_status(struct mii_softc *);
345 void mii_phy_update(struct mii_softc *, int);
346
347 /* MII must be LOCKED */
348 u_int mii_phy_flowstatus(struct mii_softc *);
349
350 /* MII must be LOCKED */
351 void ukphy_status(struct mii_softc *);
352
353 u_int mii_oui(uint16_t, uint16_t);
354 #define MII_OUI(id1, id2) mii_oui(id1, id2)
355 #define MII_MODEL(id2) (((id2) & IDR2_MODEL) >> 4)
356 #define MII_REV(id2) ((id2) & IDR2_REV)
357
358 /* Max length for phy's verbose oui+model */
359 #define MII_MAX_DESCR_LEN 68
360
361 #endif /* _KERNEL */
362
363 #endif /* _DEV_MII_MIIVAR_H_ */
364