1 | /* $NetBSD: miivar.h,v 1.62 2014/05/28 09:49:55 msaitoh Exp $ */ |
2 | |
3 | /*- |
4 | * Copyright (c) 1998, 1999, 2000, 2001 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 | |
39 | #include <dev/mii/mii_verbose.h> |
40 | |
41 | /* |
42 | * Media Independent Interface data structure definitions. |
43 | */ |
44 | |
45 | struct ifnet; |
46 | struct mii_softc; |
47 | |
48 | /* |
49 | * Callbacks from MII layer into network interface device driver. |
50 | */ |
51 | typedef int (*mii_readreg_t)(device_t, int, int); |
52 | typedef void (*mii_writereg_t)(device_t, int, int, int); |
53 | typedef void (*mii_statchg_t)(struct ifnet *); |
54 | |
55 | /* |
56 | * A network interface driver has one of these structures in its softc. |
57 | * It is the interface from the network interface driver to the MII |
58 | * layer. |
59 | */ |
60 | struct mii_data { |
61 | struct ifmedia mii_media; /* media information */ |
62 | struct ifnet *mii_ifp; /* pointer back to network interface */ |
63 | |
64 | int mii_flags; /* misc. flags; see below */ |
65 | |
66 | /* |
67 | * For network interfaces with multiple PHYs, a list of all |
68 | * PHYs is required so they can all be notified when a media |
69 | * request is made. |
70 | */ |
71 | LIST_HEAD(mii_listhead, mii_softc) mii_phys; |
72 | u_int mii_instance; |
73 | |
74 | /* |
75 | * PHY driver fills this in with active media status. |
76 | */ |
77 | int mii_media_status; |
78 | u_int mii_media_active; |
79 | |
80 | /* |
81 | * Calls from MII layer into network interface driver. |
82 | */ |
83 | mii_readreg_t mii_readreg; |
84 | mii_writereg_t mii_writereg; |
85 | mii_statchg_t mii_statchg; |
86 | }; |
87 | typedef struct mii_data mii_data_t; |
88 | |
89 | /* |
90 | * Functions provided by the PHY to perform various functions. |
91 | */ |
92 | struct mii_phy_funcs { |
93 | int (*pf_service)(struct mii_softc *, struct mii_data *, int); |
94 | void (*pf_status)(struct mii_softc *); |
95 | void (*pf_reset)(struct mii_softc *); |
96 | }; |
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 | device_t mii_dev; /* generic device glue */ |
113 | |
114 | LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */ |
115 | |
116 | uint32_t mii_mpd_oui; /* the PHY's OUI (MII_OUI())*/ |
117 | uint32_t mii_mpd_model; /* the PHY's model (MII_MODEL())*/ |
118 | uint32_t mii_mpd_rev; /* the PHY's revision (MII_REV())*/ |
119 | int mii_phy; /* our MII address */ |
120 | int mii_offset; /* first PHY, second PHY, etc. */ |
121 | u_int mii_inst; /* instance for ifmedia */ |
122 | |
123 | /* Our PHY functions. */ |
124 | const struct mii_phy_funcs *mii_funcs; |
125 | |
126 | struct mii_data *mii_pdata; /* pointer to parent's mii_data */ |
127 | |
128 | int mii_flags; /* misc. flags; see below */ |
129 | int mii_capabilities; /* capabilities from BMSR */ |
130 | int mii_extcapabilities; /* extended capabilities */ |
131 | int mii_ticks; /* MII_TICK counter */ |
132 | int mii_anegticks; /* ticks before retrying aneg */ |
133 | |
134 | struct callout mii_nway_ch; /* NWAY callout */ |
135 | |
136 | u_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 | /* Default mii_anegticks values. */ |
142 | #define MII_ANEGTICKS 5 |
143 | #define MII_ANEGTICKS_GIGE 10 |
144 | |
145 | /* mii_flags */ |
146 | #define MIIF_INITDONE 0x0001 /* has been initialized (mii_data) */ |
147 | #define MIIF_NOISOLATE 0x0002 /* do not isolate the PHY */ |
148 | #define MIIF_NOLOOP 0x0004 /* no loopback capability */ |
149 | #define MIIF_DOINGAUTO 0x0008 /* doing autonegotiation (mii_softc) */ |
150 | #define MIIF_AUTOTSLEEP 0x0010 /* use tsleep(), not callout() */ |
151 | #define MIIF_HAVEFIBER 0x0020 /* from parent: has fiber interface */ |
152 | #define MIIF_HAVE_GTCR 0x0040 /* has 100base-T2/1000base-T CR */ |
153 | #define MIIF_IS_1000X 0x0080 /* is a 1000BASE-X device */ |
154 | #define MIIF_DOPAUSE 0x0100 /* advertise PAUSE capability */ |
155 | #define MIIF_IS_HPNA 0x0200 /* is a HomePNA device */ |
156 | #define MIIF_FORCEANEG 0x0400 /* force auto-negotiation */ |
157 | |
158 | #define MIIF_INHERIT_MASK (MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP) |
159 | |
160 | /* |
161 | * Special `locators' passed to mii_attach(). If one of these is not |
162 | * an `any' value, we look for *that* PHY and configure it. If both |
163 | * are not `any', that is an error, and mii_attach() will panic. |
164 | */ |
165 | #define MII_OFFSET_ANY -1 |
166 | #define MII_PHY_ANY -1 |
167 | |
168 | /* |
169 | * Used to attach a PHY to a parent. |
170 | */ |
171 | struct mii_attach_args { |
172 | struct mii_data *mii_data; /* pointer to parent data */ |
173 | int mii_phyno; /* MII address */ |
174 | u_int mii_id1; /* PHY ID register 1 */ |
175 | u_int mii_id2; /* PHY ID register 2 */ |
176 | int mii_capmask; /* capability mask from BMSR */ |
177 | int mii_flags; /* flags from parent */ |
178 | }; |
179 | typedef struct mii_attach_args mii_attach_args_t; |
180 | |
181 | /* |
182 | * Used to match a PHY. |
183 | */ |
184 | struct mii_phydesc { |
185 | u_int32_t mpd_oui; /* the PHY's OUI */ |
186 | u_int32_t mpd_model; /* the PHY's model */ |
187 | const char *mpd_name; /* the PHY's name */ |
188 | }; |
189 | |
190 | /* |
191 | * An array of these structures map MII media types to BMCR/ANAR settings. |
192 | */ |
193 | struct mii_media { |
194 | int mm_bmcr; /* BMCR settings for this media */ |
195 | int mm_anar; /* ANAR settings for this media */ |
196 | int mm_gtcr; /* 100base-T2 or 1000base-T CR */ |
197 | }; |
198 | |
199 | #define MII_MEDIA_NONE 0 |
200 | #define MII_MEDIA_10_T 1 |
201 | #define MII_MEDIA_10_T_FDX 2 |
202 | #define MII_MEDIA_100_T4 3 |
203 | #define MII_MEDIA_100_TX 4 |
204 | #define MII_MEDIA_100_TX_FDX 5 |
205 | #define MII_MEDIA_1000_X 6 |
206 | #define MII_MEDIA_1000_X_FDX 7 |
207 | #define MII_MEDIA_1000_T 8 |
208 | #define MII_MEDIA_1000_T_FDX 9 |
209 | #define MII_NMEDIA 10 |
210 | |
211 | #ifdef _KERNEL |
212 | |
213 | #define PHY_READ(p, r) \ |
214 | (*(p)->mii_pdata->mii_readreg)(device_parent((p)->mii_dev), \ |
215 | (p)->mii_phy, (r)) |
216 | |
217 | #define PHY_WRITE(p, r, v) \ |
218 | (*(p)->mii_pdata->mii_writereg)(device_parent((p)->mii_dev), \ |
219 | (p)->mii_phy, (r), (v)) |
220 | |
221 | #define PHY_SERVICE(p, d, o) \ |
222 | (*(p)->mii_funcs->pf_service)((p), (d), (o)) |
223 | |
224 | #define PHY_STATUS(p) \ |
225 | (*(p)->mii_funcs->pf_status)((p)) |
226 | |
227 | #define PHY_RESET(p) \ |
228 | (*(p)->mii_funcs->pf_reset)((p)) |
229 | |
230 | void mii_attach(device_t, struct mii_data *, int, int, int, int); |
231 | void mii_detach(struct mii_data *, int, int); |
232 | bool mii_phy_resume(device_t, const pmf_qual_t *); |
233 | |
234 | int mii_mediachg(struct mii_data *); |
235 | void mii_tick(struct mii_data *); |
236 | void mii_pollstat(struct mii_data *); |
237 | void mii_down(struct mii_data *); |
238 | int mii_anar(int); |
239 | |
240 | int mii_ifmedia_change(struct mii_data *); |
241 | |
242 | int mii_phy_activate(device_t, enum devact); |
243 | int mii_phy_detach(device_t, int); |
244 | |
245 | const struct mii_phydesc *mii_phy_match(const struct mii_attach_args *, |
246 | const struct mii_phydesc *); |
247 | |
248 | void mii_phy_add_media(struct mii_softc *); |
249 | void mii_phy_delete_media(struct mii_softc *); |
250 | |
251 | void mii_phy_setmedia(struct mii_softc *); |
252 | int mii_phy_auto(struct mii_softc *, int); |
253 | void mii_phy_reset(struct mii_softc *); |
254 | void mii_phy_down(struct mii_softc *); |
255 | int mii_phy_tick(struct mii_softc *); |
256 | |
257 | void mii_phy_status(struct mii_softc *); |
258 | void mii_phy_update(struct mii_softc *, int); |
259 | |
260 | u_int mii_phy_flowstatus(struct mii_softc *); |
261 | |
262 | void ukphy_status(struct mii_softc *); |
263 | |
264 | u_int mii_oui(u_int, u_int); |
265 | #define MII_OUI(id1, id2) mii_oui(id1, id2) |
266 | #define MII_MODEL(id2) (((id2) & IDR2_MODEL) >> 4) |
267 | #define MII_REV(id2) ((id2) & IDR2_REV) |
268 | |
269 | #endif /* _KERNEL */ |
270 | |
271 | #endif /* _DEV_MII_MIIVAR_H_ */ |
272 | |