miivar.h revision 1.34 
1/*	$OpenBSD: miivar.h,v 1.34 2015/09/12 09:49:20 miod Exp $	*/
2/*	$NetBSD: miivar.h,v 1.17 2000/03/06 20:56:57 thorpej Exp $	*/
3
4/*-
5 * Copyright (c) 1998, 1999, 2000 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 *
21 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 */
33
34#ifndef _DEV_MII_MIIVAR_H_
35#define	_DEV_MII_MIIVAR_H_
36
37#include <sys/queue.h>
38#include <sys/timeout.h>
39
40/*
41 * Media Independent Interface autoconfiguration definitions.
42 *
43 * This file exports an interface which attempts to be compatible
44 * with the BSD/OS 3.0 interface.
45 */
46
47struct mii_softc;
48
49/*
50 * Callbacks from MII layer into network interface device driver.
51 */
52typedef	int (*mii_readreg_t)(struct device *, int, int);
53typedef	void (*mii_writereg_t)(struct device *, int, int, int);
54typedef	void (*mii_statchg_t)(struct device *);
55
56/*
57 * A network interface driver has one of these structures in its softc.
58 * It is the interface from the network interface driver to the MII
59 * layer.
60 */
61struct mii_data {
62	struct ifmedia mii_media;	/* media information */
63	struct ifnet *mii_ifp;		/* pointer back to network interface */
64
65	int mii_flags;			/* misc. flags; see below */
66
67	/*
68	 * For network interfaces with multiple PHYs, a list of all
69	 * PHYs is required so they can all be notified when a media
70	 * request is made.
71	 */
72	LIST_HEAD(mii_listhead, mii_softc) mii_phys;
73	uint64_t mii_instance;
74
75	/*
76	 * PHY driver fills this in with active media status.
77	 */
78	uint64_t mii_media_status;
79	uint64_t mii_media_active;
80
81	/*
82	 * Calls from MII layer into network interface driver.
83	 */
84	mii_readreg_t mii_readreg;
85	mii_writereg_t mii_writereg;
86	mii_statchg_t mii_statchg;
87};
88typedef struct mii_data mii_data_t;
89
90struct mii_phy_funcs {
91	int (*pf_service)(struct mii_softc *, struct mii_data *, int);
92	void (*pf_status)(struct mii_softc *);
93	void (*pf_reset)(struct mii_softc *);
94};
95
96/*
97 * Requests that can be made to the downcall.
98 */
99#define	MII_TICK	1	/* once-per-second tick */
100#define	MII_MEDIACHG	2	/* user changed media; perform the switch */
101#define	MII_POLLSTAT	3	/* user requested media status; fill it in */
102#define	MII_DOWN	4	/* interface is down */
103
104/*
105 * Each PHY driver's softc has one of these as the first member.
106 * XXX This would be better named "phy_softc", but this is the name
107 * XXX BSDI used, and we would like to have the same interface.
108 */
109struct mii_softc {
110	struct device mii_dev;		/* generic device glue */
111
112	LIST_ENTRY(mii_softc) mii_list;	/* entry on parent's PHY list */
113
114	int mii_phy;			/* our MII address */
115	int mii_oui;			/* MII_OUI(ma->mii_id1, ma->mii_id2) */
116	int mii_model;			/* MII_MODEL(ma->mii_id2) */
117	int mii_rev;			/* MII_REV(ma->mii_id2) */
118	int mii_offset;			/* first PHY, second PHY, etc. */
119	uint64_t mii_inst;		/* instance for ifmedia */
120
121	/* Our PHY functions. */
122	const struct mii_phy_funcs *mii_funcs;
123
124	struct mii_data *mii_pdata;	/* pointer to parent's mii_data */
125
126	int mii_flags;			/* misc. flags; see below */
127	int mii_capabilities;		/* capabilities from BMSR */
128	int mii_extcapabilities;	/* extended capabilities */
129	int mii_ticks;			/* MII_TICK counter */
130	int mii_anegticks;		/* ticks before retrying aneg */
131
132	struct timeout mii_phy_timo;	/* timeout handle */
133
134	uint64_t mii_media_active;		/* last active media */
135	uint64_t mii_media_status;		/* last active status */
136};
137typedef struct mii_softc mii_softc_t;
138
139/* Default mii_anegticks values. */
140#define MII_ANEGTICKS		5
141#define MII_ANEGTICKS_GIGE	10
142
143/* mii_flags */
144#define	MIIF_INITDONE	0x0001		/* has been initialized (mii_data) */
145#define	MIIF_NOISOLATE	0x0002		/* do not isolate the PHY */
146#define	MIIF_NOLOOP	0x0004		/* no loopback capability */
147#define	MIIF_DOINGAUTO	0x0008		/* doing autonegotiation (mii_softc) */
148#define MIIF_AUTOTSLEEP	0x0010		/* use tsleep(), not timeout() */
149#define MIIF_HAVEFIBER	0x0020		/* from parent: has fiber interface */
150#define	MIIF_HAVE_GTCR	0x0040		/* has 100base-T2/1000base-T CR */
151#define	MIIF_IS_1000X	0x0080		/* is a 1000BASE-X device */
152#define	MIIF_DOPAUSE	0x0100		/* advertise PAUSE capability */
153#define	MIIF_IS_HPNA	0x0200		/* is a HomePNA device */
154#define	MIIF_FORCEANEG	0x0400		/* force autonegotiation */
155
156#define	MIIF_INHERIT_MASK	(MIIF_NOISOLATE|MIIF_NOLOOP|MIIF_AUTOTSLEEP)
157
158/*
159 * Special `locators' passed to mii_attach().  If one of these is not
160 * an `any' value, we look for *that* PHY and configure it.  If both
161 * are not `any', that is an error, and mii_attach() will panic.
162 */
163#define	MII_OFFSET_ANY		-1
164#define	MII_PHY_ANY		-1
165
166/*
167 * Used to attach a PHY to a parent.
168 */
169struct mii_attach_args {
170	struct mii_data *mii_data;	/* pointer to parent data */
171	int mii_phyno;			/* MII address */
172	int mii_id1;			/* PHY ID register 1 */
173	int mii_id2;			/* PHY ID register 2 */
174	int mii_capmask;		/* capability mask from BMSR */
175	int mii_flags;			/* flags from parent */
176};
177typedef struct mii_attach_args mii_attach_args_t;
178
179/*
180 * Used to match a PHY.
181 */
182struct mii_phydesc {
183	u_int32_t mpd_oui;		/* the PHY's OUI */
184	u_int32_t mpd_model;		/* the PHY's model */
185	const char *mpd_name;		/* the PHY's name */
186};
187
188/*
189 * An array of these structures map MII media types to BMCR/ANAR settings.
190 */
191struct mii_media {
192	int	mm_bmcr;		/* BMCR settings for this media */
193	int	mm_anar;		/* ANAR settings for this media */
194	int	mm_gtcr;		/* 100base-T2 or 1000base-T CR */
195};
196
197#define	MII_MEDIA_NONE		0
198#define	MII_MEDIA_10_T		1
199#define	MII_MEDIA_10_T_FDX	2
200#define	MII_MEDIA_100_T4	3
201#define	MII_MEDIA_100_TX	4
202#define	MII_MEDIA_100_TX_FDX	5
203#define	MII_MEDIA_1000_X	6
204#define	MII_MEDIA_1000_X_FDX	7
205#define	MII_MEDIA_1000_T	8
206#define	MII_MEDIA_1000_T_FDX	9
207#define	MII_NMEDIA		10
208
209#ifdef _KERNEL
210
211#define	PHY_READ(p, r) \
212	(*(p)->mii_pdata->mii_readreg)((p)->mii_dev.dv_parent, \
213	    (p)->mii_phy, (r))
214
215#define	PHY_WRITE(p, r, v) \
216	(*(p)->mii_pdata->mii_writereg)((p)->mii_dev.dv_parent, \
217	    (p)->mii_phy, (r), (v))
218
219#define	PHY_SERVICE(p, d, o) \
220	(*(p)->mii_funcs->pf_service)((p), (d), (o))
221
222#define	PHY_STATUS(p) \
223	(*(p)->mii_funcs->pf_status)((p))
224
225#define	PHY_RESET(p) \
226	(*(p)->mii_funcs->pf_reset)((p))
227
228#define mii_phy_probe(x, y, z) \
229	mii_attach((x), (y), (z), MII_PHY_ANY, MII_OFFSET_ANY, 0)
230
231#define MII_OUI(id1, id2)	(((id1) << 6) | ((id2) >> 10))
232#define MII_MODEL(id2)		(((id2) & IDR2_MODEL) >> 4)
233#define MII_REV(id2)		((id2) & IDR2_REV)
234
235void	mii_attach(struct device *, struct mii_data *, int, int,
236	    int, int);
237void	mii_detach(struct mii_data *, int, int);
238
239int	mii_mediachg(struct mii_data *);
240void	mii_tick(struct mii_data *);
241void	mii_pollstat(struct mii_data *);
242void	mii_down(struct mii_data *);
243int	mii_anar(uint64_t);
244
245int	mii_phy_detach(struct device *, int);
246
247const struct mii_phydesc *mii_phy_match(const struct mii_attach_args *,
248	    const struct mii_phydesc *);
249
250void	mii_phy_add_media(struct mii_softc *);
251void	mii_phy_delete_media(struct mii_softc *);
252
253void	mii_phy_setmedia(struct mii_softc *);
254int	mii_phy_auto(struct mii_softc *, int);
255void	mii_phy_auto_timeout(void *);
256void	mii_phy_reset(struct mii_softc *);
257void	mii_phy_down(struct mii_softc *);
258int	mii_phy_tick(struct mii_softc *);
259
260void	mii_phy_status(struct mii_softc *);
261void	mii_phy_update(struct mii_softc *, int);
262int	mii_phy_statusmsg(struct mii_softc *);
263
264uint64_t	mii_phy_flowstatus(struct mii_softc *);
265
266void	ukphy_status(struct mii_softc *);
267
268#endif /* _KERNEL */
269
270#endif /* _DEV_MII_MIIVAR_H_ */
271