Merge branch 'vendor/MDOCML'
[dragonfly.git] / share / man / man4 / miibus.4
1 .\" Written by Tom Rhodes for the FreeBSD Project.
2 .\" Please see the /usr/src/COPYRIGHT file for copyright information.
3 .\"
4 .\" This document takes information from the IEEE 802.3 Standard
5 .\" along with various comments from Peter Wemm, Robert Watson, and Bill Paul.
6 .\" Originally this file looked much like the NetBSD mii(4) manual page, but
7 .\" I doubt you would ever notice due to large differences.
8 .\"
9 .\" $FreeBSD: src/share/man/man4/miibus.4,v 1.3.2.6 2004/03/01 09:22:11 brueffer Exp $
10 .\" $DragonFly: src/share/man/man4/miibus.4,v 1.17 2008/07/26 17:03:53 swildner Exp $
11 .\"
12 .Dd July 26, 2008
13 .Dt MIIBUS 4
14 .Os
15 .Sh NAME
16 .Nm miibus
17 .Nd IEEE 802.3 Media Independent Interface network bus
18 .Sh SYNOPSIS
19 For most network interface cards (NIC):
20 .Cd "device miibus"
21 .Sh DESCRIPTION
22 The
23 .Nm
24 driver provides an interconnection between the Media Access Control (MAC)
25 sublayer, the Physical Layer entities (PHY), Station Management (STA)
26 entities, and the PHY Layer as defined by the IEEE 802.3 Standard.
27 .Pp
28 The
29 .Nm
30 layer allows network device drivers to share common support
31 code for various external PHY devices.
32 Most 10/100 network interface cards either use an MII transceiver
33 or have built-in transceivers that can be programmed using an MII
34 interface.
35 The
36 .Nm
37 driver currently handles all of the media detection,
38 selection, and reporting using the
39 .Xr ifmedia 4
40 interface.
41 A generic driver has been included for all PHYs that are not
42 handled by a specific driver, this is possible because all
43 10/100 PHYs implement the same general register set along with
44 their vendor specific register set.
45 .Pp
46 The following network device drivers use the
47 .Nm
48 interface:
49 .Pp
50 .Bl -tag -compact -width ".Xr stge 4"
51 .It Xr aue 4
52 ADMtek USB Ethernet
53 .It Xr axe 4
54 ASIX Electronics AX88172 USB Ethernet
55 .It Xr bce 4
56 Broadcom BCM5706/BCM5708 Gigabit Ethernet
57 .It Xr bfe 4
58 Broadcom BCM440x 10/100 Ethernet
59 .It Xr bge 4
60 Broadcom BCM570xx Gigabit Ethernet
61 .It Xr dc 4
62 DEC/Intel 21143 and various workalikes
63 .It Xr ed 4
64 NE[12]000, SMC Ultra, 3c503, DS8390 cards
65 .It Xr et 4
66 Agere ET1310 10/100/1000 Ethernet
67 .It Xr fxp 4
68 Intel EtherExpress PRO/100B
69 .It Xr jme 4
70 JMicron Gigabit Ethernet
71 .It Xr lge 4
72 Level 1 LXT1001 NetCellerator Gigabit Ethernet
73 .It Xr msk 4
74 Marvell/SysKonnect Yukon II Gigabit Ethernet
75 .It Xr nfe 4
76 NVIDIA nForce MCP 10/100/Gigabit Ethernet
77 .It Xr nge 4
78 National Semiconductor DP83820/DP83821 Gigabit Ethernet
79 .It Xr pcn 4
80 AMD Am79C97x PCI 10/100
81 .It Xr re 4
82 RealTek 8139C+/8169/8169S/8110S
83 .It Xr rl 4
84 RealTek 8129/8139
85 .It Xr rue 4
86 RealTek RTL8150 USB To Fast Ethernet
87 .It Xr sf 4
88 Adaptec AIC-6915
89 .It Xr sis 4
90 Silicon Integrated Systems SiS 900/SiS 7016
91 .It Xr sk 4
92 SysKonnect SK-984x and SK-982x Gigabit Ethernet
93 .It Xr ste 4
94 Sundance ST201 (D-Link DFE-550TX)
95 .It Xr stge 4
96 Sundance/Tamarack TC9021 Gigabit Ethernet
97 .It Xr tl 4
98 Texas Instruments ThunderLAN
99 .It Xr tx 4
100 SMC EtherPower II (83c170)
101 .It Xr vge 4
102 VIA Networking Technologies VT6122 PCI Gigabit Ethernet
103 .It Xr vr 4
104 VIA Rhine, Rhine II
105 .It Xr wb 4
106 Winbond W89C840F
107 .It Xr xl 4
108 3Com 3c90x
109 .El
110 .Sh COMPATIBILITY
111 The implementation of
112 .Nm
113 was originally intended to have similar API interfaces
114 to
115 .Bsx 3.0
116 and
117 .Nx ,
118 but as a result are not well behaved newbus device drivers.
119 .Sh SEE ALSO
120 .Xr arp 4 ,
121 .Xr aue 4 ,
122 .Xr axe 4 ,
123 .Xr bce 4 ,
124 .Xr bfe 4 ,
125 .Xr bge 4 ,
126 .Xr dc 4 ,
127 .Xr ed 4 ,
128 .Xr et 4 ,
129 .Xr fxp 4 ,
130 .Xr jme 4 ,
131 .Xr lge 4 ,
132 .Xr msk 4 ,
133 .Xr netintro 4 ,
134 .Xr nfe 4 ,
135 .Xr nge 4 ,
136 .Xr pcn 4 ,
137 .Xr re 4 ,
138 .Xr rl 4 ,
139 .Xr rue 4 ,
140 .Xr sf 4 ,
141 .Xr sis 4 ,
142 .Xr sk 4 ,
143 .Xr ste 4 ,
144 .Xr stge 4 ,
145 .Xr tl 4 ,
146 .Xr tx 4 ,
147 .Xr vge 4 ,
148 .Xr vr 4 ,
149 .Xr wb 4 ,
150 .Xr xl 4
151 .Sh STANDARDS
152 More information on MII can be found in the IEEE 802.3 Standard.
153 .Sh HISTORY
154 The
155 .Nm
156 driver first appeared in
157 .Fx 3.3 .
158 .Sh AUTHORS
159 This manual page was written by
160 .An Tom Rhodes Aq trhodes@FreeBSD.org .