miivar.h revision 1.4 1 /* $NetBSD: miivar.h,v 1.4 1998/11/04 23:28:15 thorpej Exp $ */
2
3 /*-
4 * Copyright (c) 1998 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 autoconfiguration defintions.
47 *
48 * This file exports an interface which attempts to be compatible
49 * with the BSD/OS 3.0 interface.
50 */
51
52 struct mii_softc;
53
54 /*
55 * Callbacks from MII layer into network interface device driver.
56 */
57 typedef int (*mii_readreg_t) __P((struct device *, int, int));
58 typedef void (*mii_writereg_t) __P((struct device *, int, int, int));
59 typedef void (*mii_statchg_t) __P((struct device *));
60
61 /*
62 * A network interface driver has one of these structures in its softc.
63 * It is the interface from the network interface driver to the MII
64 * layer.
65 */
66 struct mii_data {
67 struct ifmedia mii_media; /* media information */
68 struct ifnet *mii_ifp; /* pointer back to network interface */
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 * Requests that can be made to the downcall.
101 */
102 #define MII_TICK 1 /* once-per-second tick */
103 #define MII_MEDIACHG 2 /* user changed media; perform the switch */
104 #define MII_POLLSTAT 3 /* user requested media status; fill it in */
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 struct device mii_dev; /* generic device glue */
113
114 LIST_ENTRY(mii_softc) mii_list; /* entry on parent's PHY list */
115
116 int mii_phy; /* our MII address */
117 int mii_inst; /* instance for ifmedia */
118
119 mii_downcall_t mii_service; /* our downcall */
120 struct mii_data *mii_pdata; /* pointer to parent's mii_data */
121
122 int mii_flags; /* misc. flags; see below */
123 int mii_capabilities; /* capabilities from BMSR */
124 };
125 typedef struct mii_softc mii_softc_t;
126
127 /* mii_flags */
128 #define MIIF_NOISOLATE 0x0001 /* do not isolate the PHY */
129
130 /*
131 * Used to attach a PHY to a parent.
132 */
133 struct mii_attach_args {
134 struct mii_data *mii_data; /* pointer to parent data */
135 int mii_phyno; /* MII address */
136 int mii_id1; /* PHY ID register 1 */
137 int mii_id2; /* PHY ID register 2 */
138 int mii_capmask; /* capability mask from BMSR */
139 };
140 typedef struct mii_attach_args mii_attach_args_t;
141
142 #ifdef _KERNEL
143 #include "locators.h"
144
145 #define PHY_READ(p, r) \
146 (*(p)->mii_pdata->mii_readreg)((p)->mii_dev.dv_parent, \
147 (p)->mii_phy, (r))
148
149 #define PHY_WRITE(p, r, v) \
150 (*(p)->mii_pdata->mii_writereg)((p)->mii_dev.dv_parent, \
151 (p)->mii_phy, (r), (v))
152
153 int mii_anar __P((int));
154 int mii_mediachg __P((struct mii_data *));
155 void mii_tick __P((struct mii_data *));
156 void mii_pollstat __P((struct mii_data *));
157 void mii_phy_probe __P((struct device *, struct mii_data *, int));
158 void mii_add_media __P((struct mii_data *, int, int));
159
160 int mii_phy_auto __P((struct mii_softc *));
161 void mii_phy_reset __P((struct mii_softc *));
162 #endif /* _KERNEL */
163
164 #endif /* _DEV_MII_MIIVAR_H_ */
165