freebsd-dev/share/man/man4/miibus.4

.\" Written by Tom Rhodes for the FreeBSD Project.
.\" Please see the /usr/src/COPYRIGHT file for copyright information.
.\"
.\" This document takes information from the IEEE 802.3 Standard
.\" along with various comments from Peter Wemm, Robert Watson, and Bill Paul.
.\" Originally this file looked much like the NetBSD mii(4) manual page, but
.\" I doubt you would ever notice due to large differences.
.\"
.\" $FreeBSD$
.\"
.Dd January 15, 2011
.Dt MIIBUS 4
.Os
.Sh NAME
.Nm miibus
.Nd IEEE 802.3 Media Independent Interface network bus
.Sh SYNOPSIS
For most network interface cards (NIC):
.Cd "device miibus"
.Sh DESCRIPTION
The
.Nm
driver provides an interconnection between the Media Access Control (MAC)
sublayer, the Physical Layer entities (PHY), Station Management (STA)
entities, and the PHY Layer as defined by the IEEE 802.3 Standard.
.Pp
The
.Nm
layer allows network device drivers to share common support
code for various external PHY devices.
Most 10/100 network interface cards either use an MII transceiver
or have built-in transceivers that can be programmed using an MII
interface.
The
.Nm
driver currently handles all of the media detection,
selection, and reporting using the ifmedia interface.
A generic driver has been included for all PHYs that are not
handled by a specific driver, this is possible because all
10/100 PHYs implement the same general register set along with
their vendor specific register set.
.Pp
The following network device drivers use the
.Nm
interface:
.Pp
.Bl -tag -compact -width ".Xr fxp 4"
.It Xr ae 4
Attansic/Atheros L2 Fast Ethernet
.It Xr age 4
Attansic/Atheros L1 Gigabit Ethernet
.It Xr alc 4
Atheros AR8131/AR8132 PCIe Ethernet
.It Xr ale 4
Atheros AR8121/AR8113/AR8114 PCIe Ethernet
.It Xr aue 4
ADMtek USB Ethernet
.It Xr axe 4
ASIX Electronics AX88172 USB Ethernet
.It Xr bce 4
Broadcom NetXtreme II Gigabit Ethernet
.It Xr bfe 4
Broadcom BCM4401 Ethernet
.It Xr bge 4
Broadcom BCM570xx Gigabit Ethernet
.It Xr cas 4
Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
.It Xr dc 4
DEC/Intel 21143 and various workalikes
.It Xr ed 4
NE[12]000, SMC Ultra, 3c503, DS8390 cards
.It Xr et 4
Agere ET1310 Gigabit Ethernet
.It Xr fxp 4
Intel EtherExpress PRO/100B
.It Xr gem 4
Sun ERI, Sun GEM and Apple GMAC Ethernet
.It Xr hme 4
Sun HME Ethernet
.It Xr jme 4
JMicron JMC250 Gigabit/JMC260 Fast Ethernet
.It Xr lge 4
Level 1 LXT1001 NetCellerator Gigabit Ethernet
.It Xr msk 4
Marvell/SysKonnect Yukon II Gigabit Ethernet
.It Xr nfe 4
NVIDIA nForce MCP Networking Adapter
.It Xr nge 4
National Semiconductor DP83820/DP83821 Gigabit Ethernet
.It Xr nve 4
NVIDIA nForce MCP Networking Adapter
.It Xr pcn 4
AMD Am79C97x PCI 10/100
.It Xr re 4
RealTek 8139C+/8169/8169S/8110S
.It Xr rl 4
RealTek 8129/8139
.It Xr rue 4
RealTek RTL8150 USB To Fast Ethernet
.It Xr sf 4
Adaptec AIC-6915
.It Xr sge 4
Silicon Integrated Systems SiS190/191 Ethernet
.It Xr sis 4
Silicon Integrated Systems SiS 900/SiS 7016
.It Xr sk 4
SysKonnect SK-984x and SK-982x Gigabit Ethernet
.It Xr ste 4
Sundance ST201 (D-Link DFE-550TX)
.It Xr stge 4
Sundance/Tamarack TC9021 Gigabit Ethernet
.It Xr tl 4
Texas Instruments ThunderLAN
.It Xr tx 4
SMC EtherPower II (83c170)
.It Xr udav 4
Davicom DM9601 USB Ethernet
.It Xr vge 4
VIA VT612x PCI Gigabit Ethernet
.It Xr vr 4
VIA Rhine, Rhine II
.It Xr vte 4
DM&P Vortex86 RDC R6040 Fast Ethernet
.It Xr wb 4
Winbond W89C840F
.It Xr xl 4
3Com 3c90x
.El
.Sh COMPATIBILITY
The implementation of
.Nm
was originally intended to have similar API interfaces
to
.Bsx 3.0
and
.Nx ,
but as a result are not well behaved newbus device drivers.
.Sh SEE ALSO
.Xr ae 4 ,
.Xr age 4 ,
.Xr alc 4 ,
.Xr ale 4 ,
.Xr arp 4 ,
.Xr aue 4 ,
.Xr axe 4 ,
.Xr bce 4 ,
.Xr bfe 4 ,
.Xr bge 4 ,
.Xr cas 4 ,
.Xr dc 4 ,
.Xr ed 4 ,
.Xr et 4 ,
.Xr fxp 4 ,
.Xr gem 4 ,
.Xr hme 4 ,
.Xr jme 4 ,
.Xr lge 4 ,
.Xr msk 4 ,
.Xr netintro 4 ,
.Xr nfe 4 ,
.Xr nge 4 ,
.Xr nve 4 ,
.Xr pcn 4 ,
.Xr re 4 ,
.Xr rgephy 4 ,
.Xr rl 4 ,
.Xr rue 4 ,
.Xr sf 4 ,
.Xr sge 4 ,
.Xr sis 4 ,
.Xr sk 4 ,
.Xr ste 4 ,
.Xr stge 4 ,
.Xr tl 4 ,
.Xr tx 4 ,
.Xr udav 4 ,
.Xr vge 4 ,
.Xr vr 4 ,
.Xr vte 4 ,
.Xr wb 4 ,
.Xr xl 4
.Sh STANDARDS
More information on MII can be found in the IEEE 802.3 Standard.
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 3.3 .
.Sh AUTHORS
This manual page was written by
.An Tom Rhodes Aq trhodes@FreeBSD.org .
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.\" Written by Tom Rhodes for the FreeBSD Project.`
			`.\" Please see the /usr/src/COPYRIGHT file for copyright information.`
			`.\"`
			`.\" This document takes information from the IEEE 802.3 Standard`
			`.\" along with various comments from Peter Wemm, Robert Watson, and Bill Paul.`
			`.\" Originally this file looked much like the NetBSD mii(4) manual page, but`
			`.\" I doubt you would ever notice due to large differences.`
			`.\"`
			`.\" $FreeBSD$`
			`.\"`
Add a manual page for rgephy(4) and reference it as appropriate. The motivation for having rgephy.4 is to document the special media option add in r217415. MFC after: 3 days 2011-01-15 22:07:08 +00:00			`.Dd January 15, 2011`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.Dt MIIBUS 4`
			`.Os`
			`.Sh NAME`
			`.Nm miibus`
			`.Nd IEEE 802.3 Media Independent Interface network bus`
			`.Sh SYNOPSIS`
			`For most network interface cards (NIC):`
			`.Cd "device miibus"`
			`.Sh DESCRIPTION`
			`The`
			`.Nm`
			`driver provides an interconnection between the Media Access Control (MAC)`
			`sublayer, the Physical Layer entities (PHY), Station Management (STA)`
			`entities, and the PHY Layer as defined by the IEEE 802.3 Standard.`
			`.Pp`
			`The`
			`.Nm`
			`layer allows network device drivers to share common support`
			`code for various external PHY devices.`
			`Most 10/100 network interface cards either use an MII transceiver`
			`or have built-in transceivers that can be programmed using an MII`
			`interface.`
			`The`
			`.Nm`
			`driver currently handles all of the media detection,`
			`selection, and reporting using the ifmedia interface.`
			`A generic driver has been included for all PHYs that are not`
			`handled by a specific driver, this is possible because all`
			`10/100 PHYs implement the same general register set along with`
			`their vendor specific register set.`
			`.Pp`
			`The following network device drivers use the`
			`.Nm`
			`interface:`
mdoc(7) police: tidy up. 2003-02-20 20:22:20 +00:00			`.Pp`
			`.Bl -tag -compact -width ".Xr fxp 4"`
Add ae(4) to the list of drivers use the miibus interface. 2010-12-20 00:23:47 +00:00			`.It Xr ae 4`
			`Attansic/Atheros L2 Fast Ethernet`
Add age(4) to the list of drivers use the miibus interface. 2008-05-19 02:10:39 +00:00			`.It Xr age 4`
			`Attansic/Atheros L1 Gigabit Ethernet`
Add alc(4) man page and hook up ale(4) to the build. Also add Xr to appropriate man pages. 2009-06-10 02:19:54 +00:00			`.It Xr alc 4`
			`Atheros AR8131/AR8132 PCIe Ethernet`
Add ale(4) man page and hook up ale(4) to the build. Also add Xr to appropriate man pages. 2008-11-12 10:20:29 +00:00			`.It Xr ale 4`
			`Atheros AR8121/AR8113/AR8114 PCIe Ethernet`
mdoc(7) police: tidy up. 2003-02-20 20:22:20 +00:00			`.It Xr aue 4`
			`ADMtek USB Ethernet`
Remove drivers that don't need miibus(4): o an o awi Add missing drivers: o axe o bfe o gx o lge o nge o re o sk MFC after: 5 days 2004-01-09 17:17:57 +00:00			`.It Xr axe 4`
			`ASIX Electronics AX88172 USB Ethernet`
Add bce(4). 2006-04-10 20:33:42 +00:00			`.It Xr bce 4`
			`Broadcom NetXtreme II Gigabit Ethernet`
Remove drivers that don't need miibus(4): o an o awi Add missing drivers: o axe o bfe o gx o lge o nge o re o sk MFC after: 5 days 2004-01-09 17:17:57 +00:00			`.It Xr bfe 4`
			`Broadcom BCM4401 Ethernet`
mdoc(7) police: tidy up. 2003-02-20 20:22:20 +00:00			`.It Xr bge 4`
			`Broadcom BCM570xx Gigabit Ethernet`
Add a man page for cas(4) and reference it as appropriate. Approved by: re (kib) MFC after: 2 weeks 2009-06-15 18:24:04 +00:00			`.It Xr cas 4`
			`Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn`
mdoc(7) police: tidy up. 2003-02-20 20:22:20 +00:00			`.It Xr dc 4`
			`DEC/Intel 21143 and various workalikes`
			`.It Xr ed 4`
			`NE[12]000, SMC Ultra, 3c503, DS8390 cards`
Add et(4) to the list of drivers use the miibus interface 2008-08-12 01:17:34 +00:00			`.It Xr et 4`
			`Agere ET1310 Gigabit Ethernet`
mdoc(7) police: tidy up. 2003-02-20 20:22:20 +00:00			`.It Xr fxp 4`
It is not the job of this manual page to list 'supported chipsets'. PR: 60575 Submitted by: Andreas Möller 2003-12-26 16:05:45 +00:00			`Intel EtherExpress PRO/100B`
- Add manpages for the gem and hme ethernet drivers. These were obtained from NetBSD, and changed slightly to account for FreeBSD specifics. - Hook them up to the build. - Add them to the list of miibus-using drivers in miibus(4). 2003-06-10 18:53:15 +00:00			`.It Xr gem 4`
			`Sun ERI, Sun GEM and Apple GMAC Ethernet`
			`.It Xr hme 4`
			`Sun HME Ethernet`
Add jme(4) to the list of drivers use the miibus interface. 2008-05-27 02:07:30 +00:00			`.It Xr jme 4`
			`JMicron JMC250 Gigabit/JMC260 Fast Ethernet`
Remove drivers that don't need miibus(4): o an o awi Add missing drivers: o axe o bfe o gx o lge o nge o re o sk MFC after: 5 days 2004-01-09 17:17:57 +00:00			`.It Xr lge 4`
			`Level 1 LXT1001 NetCellerator Gigabit Ethernet`
Add msk(4) to the list of device drivers use the miibus interface. 2006-12-13 02:46:32 +00:00			`.It Xr msk 4`
			`Marvell/SysKonnect Yukon II Gigabit Ethernet`
Add nfe(4) to the list of device drivers use the miibus interface. 2007-06-12 02:18:04 +00:00			`.It Xr nfe 4`
			`NVIDIA nForce MCP Networking Adapter`
Remove drivers that don't need miibus(4): o an o awi Add missing drivers: o axe o bfe o gx o lge o nge o re o sk MFC after: 5 days 2004-01-09 17:17:57 +00:00			`.It Xr nge 4`
			`National Semiconductor DP83820/DP83821 Gigabit Ethernet`
Add nve(4). 2005-05-20 01:19:02 +00:00			`.It Xr nve 4`
			`NVIDIA nForce MCP Networking Adapter`
mdoc(7) police: tidy up. 2003-02-20 20:22:20 +00:00			`.It Xr pcn 4`
			`AMD Am79C97x PCI 10/100`
Remove drivers that don't need miibus(4): o an o awi Add missing drivers: o axe o bfe o gx o lge o nge o re o sk MFC after: 5 days 2004-01-09 17:17:57 +00:00			`.It Xr re 4`
			`RealTek 8139C+/8169/8169S/8110S`
mdoc(7) police: tidy up. 2003-02-20 20:22:20 +00:00			`.It Xr rl 4`
			`RealTek 8129/8139`
Add rue(4) into list of miibus-using drivers and reference. MFC after: 1 week 2003-11-16 11:52:26 +00:00			`.It Xr rue 4`
			`RealTek RTL8150 USB To Fast Ethernet`
mdoc(7) police: tidy up. 2003-02-20 20:22:20 +00:00			`.It Xr sf 4`
			`Adaptec AIC-6915`
Add sge(4) man page and hook up sge(4) to the build. Also add Xr to appropriate man pages. 2010-04-14 21:27:48 +00:00			`.It Xr sge 4`
			`Silicon Integrated Systems SiS190/191 Ethernet`
mdoc(7) police: tidy up. 2003-02-20 20:22:20 +00:00			`.It Xr sis 4`
			`Silicon Integrated Systems SiS 900/SiS 7016`
Remove drivers that don't need miibus(4): o an o awi Add missing drivers: o axe o bfe o gx o lge o nge o re o sk MFC after: 5 days 2004-01-09 17:17:57 +00:00			`.It Xr sk 4`
			`SysKonnect SK-984x and SK-982x Gigabit Ethernet`
mdoc(7) police: tidy up. 2003-02-20 20:22:20 +00:00			`.It Xr ste 4`
			`Sundance ST201 (D-Link DFE-550TX)`
Add stge(4) to the list of device drivers use the miibus interface. 2006-07-25 00:59:39 +00:00			`.It Xr stge 4`
			`Sundance/Tamarack TC9021 Gigabit Ethernet`
mdoc(7) police: tidy up. 2003-02-20 20:22:20 +00:00			`.It Xr tl 4`
			`Texas Instruments ThunderLAN`
			`.It Xr tx 4`
			`SMC EtherPower II (83c170)`
Add udav(4) 2004-02-28 02:55:12 +00:00			`.It Xr udav 4`
			`Davicom DM9601 USB Ethernet`
- add vge(4) - bump document date 2004-09-12 22:03:38 +00:00			`.It Xr vge 4`
			`VIA VT612x PCI Gigabit Ethernet`
mdoc(7) police: tidy up. 2003-02-20 20:22:20 +00:00			`.It Xr vr 4`
			`VIA Rhine, Rhine II`
Add vte(4) man page and hook up vte(4) to the build. Also add Xr to appropriate man pages. 2010-12-31 00:46:30 +00:00			`.It Xr vte 4`
			`DM&P Vortex86 RDC R6040 Fast Ethernet`
mdoc(7) police: tidy up. 2003-02-20 20:22:20 +00:00			`.It Xr wb 4`
			`Winbond W89C840F`
			`.It Xr xl 4`
			`3Com 3c90x`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.El`
			`.Sh COMPATIBILITY`
			`The implementation of`
			`.Nm`
			`was originally intended to have similar API interfaces`
			`to`
Correct the BSD/OS macro. 2003-02-16 22:30:00 +00:00			`.Bsx 3.0`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`and`
			`.Nx ,`
			`but as a result are not well behaved newbus device drivers.`
			`.Sh SEE ALSO`
Add ae(4) to the list of drivers use the miibus interface. 2010-12-20 00:23:47 +00:00			`.Xr ae 4 ,`
Add age(4) to the list of drivers use the miibus interface. 2008-05-19 02:10:39 +00:00			`.Xr age 4 ,`
Add alc(4) man page and hook up ale(4) to the build. Also add Xr to appropriate man pages. 2009-06-10 02:19:54 +00:00			`.Xr alc 4 ,`
Add ale(4) man page and hook up ale(4) to the build. Also add Xr to appropriate man pages. 2008-11-12 10:20:29 +00:00			`.Xr ale 4 ,`
1: wi(4) does not need miibus(4). 2: Add arp(4) and netintro(4) to Xrefs. 1: Discussed with: imp 2003-02-15 17:16:44 +00:00			`.Xr arp 4 ,`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.Xr aue 4 ,`
Remove drivers that don't need miibus(4): o an o awi Add missing drivers: o axe o bfe o gx o lge o nge o re o sk MFC after: 5 days 2004-01-09 17:17:57 +00:00			`.Xr axe 4 ,`
Add bce(4). 2006-04-10 20:33:42 +00:00			`.Xr bce 4 ,`
Remove drivers that don't need miibus(4): o an o awi Add missing drivers: o axe o bfe o gx o lge o nge o re o sk MFC after: 5 days 2004-01-09 17:17:57 +00:00			`.Xr bfe 4 ,`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.Xr bge 4 ,`
Add a man page for cas(4) and reference it as appropriate. Approved by: re (kib) MFC after: 2 weeks 2009-06-15 18:24:04 +00:00			`.Xr cas 4 ,`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.Xr dc 4 ,`
			`.Xr ed 4 ,`
Add et(4) to the list of drivers use the miibus interface 2008-08-12 01:17:34 +00:00			`.Xr et 4 ,`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.Xr fxp 4 ,`
- Add manpages for the gem and hme ethernet drivers. These were obtained from NetBSD, and changed slightly to account for FreeBSD specifics. - Hook them up to the build. - Add them to the list of miibus-using drivers in miibus(4). 2003-06-10 18:53:15 +00:00			`.Xr gem 4 ,`
			`.Xr hme 4 ,`
Add jme(4) to the list of drivers use the miibus interface. 2008-05-27 02:07:30 +00:00			`.Xr jme 4 ,`
Remove drivers that don't need miibus(4): o an o awi Add missing drivers: o axe o bfe o gx o lge o nge o re o sk MFC after: 5 days 2004-01-09 17:17:57 +00:00			`.Xr lge 4 ,`
Add Xref to msk(4). 2006-12-13 08:56:15 +00:00			`.Xr msk 4 ,`
1: wi(4) does not need miibus(4). 2: Add arp(4) and netintro(4) to Xrefs. 1: Discussed with: imp 2003-02-15 17:16:44 +00:00			`.Xr netintro 4 ,`
Add nfe(4) to the list of device drivers use the miibus interface. 2007-06-12 02:18:04 +00:00			`.Xr nfe 4 ,`
Remove drivers that don't need miibus(4): o an o awi Add missing drivers: o axe o bfe o gx o lge o nge o re o sk MFC after: 5 days 2004-01-09 17:17:57 +00:00			`.Xr nge 4 ,`
Add nve(4). 2005-05-20 01:19:02 +00:00			`.Xr nve 4 ,`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.Xr pcn 4 ,`
Remove drivers that don't need miibus(4): o an o awi Add missing drivers: o axe o bfe o gx o lge o nge o re o sk MFC after: 5 days 2004-01-09 17:17:57 +00:00			`.Xr re 4 ,`
Add a manual page for rgephy(4) and reference it as appropriate. The motivation for having rgephy.4 is to document the special media option add in r217415. MFC after: 3 days 2011-01-15 22:07:08 +00:00			`.Xr rgephy 4 ,`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.Xr rl 4 ,`
Add rue(4) into list of miibus-using drivers and reference. MFC after: 1 week 2003-11-16 11:52:26 +00:00			`.Xr rue 4 ,`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.Xr sf 4 ,`
Add sge(4) man page and hook up sge(4) to the build. Also add Xr to appropriate man pages. 2010-04-14 21:27:48 +00:00			`.Xr sge 4 ,`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.Xr sis 4 ,`
Remove drivers that don't need miibus(4): o an o awi Add missing drivers: o axe o bfe o gx o lge o nge o re o sk MFC after: 5 days 2004-01-09 17:17:57 +00:00			`.Xr sk 4 ,`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.Xr ste 4 ,`
Add stge(4) to the list of device drivers use the miibus interface. 2006-07-25 00:59:39 +00:00			`.Xr stge 4 ,`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.Xr tl 4 ,`
			`.Xr tx 4 ,`
Add udav(4) 2004-02-28 02:55:12 +00:00			`.Xr udav 4 ,`
- add vge(4) - bump document date 2004-09-12 22:03:38 +00:00			`.Xr vge 4 ,`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.Xr vr 4 ,`
Add vte(4) man page and hook up vte(4) to the build. Also add Xr to appropriate man pages. 2010-12-31 00:46:30 +00:00			`.Xr vte 4 ,`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.Xr wb 4 ,`
mdoc(7) police: tidy up. 2003-02-20 20:22:20 +00:00			`.Xr xl 4`
Add a manual page for miibus(4) and attach it to the build. Reviewed by: peter, rwatson (older version) 2003-02-15 16:01:36 +00:00			`.Sh STANDARDS`
			`More information on MII can be found in the IEEE 802.3 Standard.`
			`.Sh HISTORY`
			`The`
			`.Nm`
			`driver first appeared in`
			`.Fx 3.3 .`
			`.Sh AUTHORS`
			`This manual page was written by`
			`.An Tom Rhodes Aq trhodes@FreeBSD.org .`