freebsd-skq/share/man/man4/my.4

.\" Copyright (c) 2003 Hiten M. Pandya
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND ITS AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR THE CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd March 11, 2007
.Dt MY 4
.Os
.Sh NAME
.Nm my
.Nd "Myson Technology Ethernet PCI driver"
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following line in your
kernel configuration file:
.Bd -ragged -offset indent
.Cd "device my"
.Ed
.Pp
Alternatively, to load the driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
if_my_load="YES"
.Ed
.Sh DESCRIPTION
The
.Nm
driver provides support for various NICs based on the Myson chipset.
The Myson chipset is a variant of the DEC Tulip NIC chipset.
.Pp
The driver will work with almost any MII-compliant PHY, thus failure to
positively identify the chip is not a fatal error.
.Sh HARDWARE
The
.Nm
driver provides support for various NICs based on the Myson chipset.
Supported models include:
.Pp
.Bl -bullet -compact
.It
Myson MTD800 PCI Fast Ethernet chip
.It
Myson MTD803 PCI Fast Ethernet chip
.It
Myson MTD89X PCI Gigabit Ethernet chip
.El
.Sh SEE ALSO
.Xr altq 4 ,
.Xr de 4 ,
.Xr netintro 4 ,
.Xr pci 4 ,
.Xr ifconfig 8
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 4.6 .
.Sh AUTHORS
The
.Nm
driver was written by Myson Technology Inc.
.Pp
This manual page was written by
.An Hiten M. Pandya Aq Mt hmp@FreeBSD.org .
.Sh BUGS
The
.Nm
driver does not support Power Management Events (PME).
Add manual page for, Myson Technology PCI Ethernet Driver. PR: docs/39214 Reviewed by: bmah, julian, trhodes Approved by: des (mentor), re (scottl) 2003-05-18 19:02:38 +00:00			`.\" Copyright (c) 2003 Hiten M. Pandya`
			`.\" All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			`.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND ITS AND CONTRIBUTORS`
			.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
			`.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR`
			`.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR THE CONTRIBUTORS`
			`.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR`
			`.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF`
			`.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS`
			`.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN`
			`.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)`
			`.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE`
			`.\" POSSIBILITY OF SUCH DAMAGE.`
			`.\"`
			`.\" $FreeBSD$`
Assorted mdoc(7) fixes. Approved by: re (blanket) 2003-05-29 21:28:36 +00:00			`.\"`
my(4) doesn't need miibus(4). Approved by: rwatson (mentor) Obtained from: DragonFly MFC after: 1 week 2007-03-11 15:20:04 +00:00			`.Dd March 11, 2007`
Add manual page for, Myson Technology PCI Ethernet Driver. PR: docs/39214 Reviewed by: bmah, julian, trhodes Approved by: des (mentor), re (scottl) 2003-05-18 19:02:38 +00:00			`.Dt MY 4`
			`.Os`
			`.Sh NAME`
			`.Nm my`
Assorted mdoc(7) fixes. Approved by: re (blanket) 2003-05-29 21:28:36 +00:00			`.Nd "Myson Technology Ethernet PCI driver"`
Add manual page for, Myson Technology PCI Ethernet Driver. PR: docs/39214 Reviewed by: bmah, julian, trhodes Approved by: des (mentor), re (scottl) 2003-05-18 19:02:38 +00:00			`.Sh SYNOPSIS`
Work around an apparent mdoc(7) bug. Spotted by: marius Discussed with: ru 2005-10-07 02:32:16 +00:00			`To compile this driver into the kernel,`
my(4) doesn't need miibus(4). Approved by: rwatson (mentor) Obtained from: DragonFly MFC after: 1 week 2007-03-11 15:20:04 +00:00			`place the following line in your`
Break long lines and kill a few instances of EOL whitespace. Noticed by: ru 2005-07-21 05:02:39 +00:00			`kernel configuration file:`
Add a "Load module on start up" comment, similar to mac_*.4 pages[1]. Quote .Cd and .Nd text. Bump doc date. Requested by: some user through ru Supported by: ru, dwmalone, brueffer 2005-07-19 00:26:30 +00:00			`.Bd -ragged -offset indent`
Add manual page for, Myson Technology PCI Ethernet Driver. PR: docs/39214 Reviewed by: bmah, julian, trhodes Approved by: des (mentor), re (scottl) 2003-05-18 19:02:38 +00:00			`.Cd "device my"`
Add a "Load module on start up" comment, similar to mac_*.4 pages[1]. Quote .Cd and .Nd text. Bump doc date. Requested by: some user through ru Supported by: ru, dwmalone, brueffer 2005-07-19 00:26:30 +00:00			`.Ed`
			`.Pp`
Work around an apparent mdoc(7) bug. Spotted by: marius Discussed with: ru 2005-10-07 02:32:16 +00:00			`Alternatively, to load the driver as a`
			`module at boot time, place the following line in`
Add a "Load module on start up" comment, similar to mac_*.4 pages[1]. Quote .Cd and .Nd text. Bump doc date. Requested by: some user through ru Supported by: ru, dwmalone, brueffer 2005-07-19 00:26:30 +00:00			`.Xr loader.conf 5 :`
			`.Bd -literal -offset indent`
			`if_my_load="YES"`
			`.Ed`
Add manual page for, Myson Technology PCI Ethernet Driver. PR: docs/39214 Reviewed by: bmah, julian, trhodes Approved by: des (mentor), re (scottl) 2003-05-18 19:02:38 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
			`driver provides support for various NICs based on the Myson chipset.`
			`The Myson chipset is a variant of the DEC Tulip NIC chipset.`
Add a HARDWARE section which lists supported devices. The actual device listings has been moved (and in some cases more or less rewritten) from the DESCRIPTION section. 2004-07-14 21:58:17 +00:00			`.Pp`
			`The driver will work with almost any MII-compliant PHY, thus failure to`
			`positively identify the chip is not a fatal error.`
			`.Sh HARDWARE`
			`The`
			`.Nm`
			`driver provides support for various NICs based on the Myson chipset.`
Add manual page for, Myson Technology PCI Ethernet Driver. PR: docs/39214 Reviewed by: bmah, julian, trhodes Approved by: des (mentor), re (scottl) 2003-05-18 19:02:38 +00:00			`Supported models include:`
Assorted mdoc(7) fixes. Approved by: re (blanket) 2003-05-29 21:28:36 +00:00			`.Pp`
Add manual page for, Myson Technology PCI Ethernet Driver. PR: docs/39214 Reviewed by: bmah, julian, trhodes Approved by: des (mentor), re (scottl) 2003-05-18 19:02:38 +00:00			`.Bl -bullet -compact`
			`.It`
			`Myson MTD800 PCI Fast Ethernet chip`
			`.It`
			`Myson MTD803 PCI Fast Ethernet chip`
Catch up my(4) with hardware notes by adding Myson MTD89X to list of supported devices. Submitted by: Lukas Ertl <l.ertl@univie.ac.at> PR: docs/56244 Confirmed by: driver source code 2003-08-31 19:37:48 +00:00			`.It`
			`Myson MTD89X PCI Gigabit Ethernet chip`
Add manual page for, Myson Technology PCI Ethernet Driver. PR: docs/39214 Reviewed by: bmah, julian, trhodes Approved by: des (mentor), re (scottl) 2003-05-18 19:02:38 +00:00			`.El`
			`.Sh SEE ALSO`
Xref altq(4) for drivers that support it according to altq(4). 2007-01-30 08:40:04 +00:00			`.Xr altq 4 ,`
Add manual page for, Myson Technology PCI Ethernet Driver. PR: docs/39214 Reviewed by: bmah, julian, trhodes Approved by: des (mentor), re (scottl) 2003-05-18 19:02:38 +00:00			`.Xr de 4 ,`
			`.Xr netintro 4 ,`
			`.Xr pci 4 ,`
			`.Xr ifconfig 8`
			`.Sh HISTORY`
			`The`
			`.Nm`
			`driver first appeared in`
			`.Fx 4.6 .`
			`.Sh AUTHORS`
			`The`
			`.Nm`
			`driver was written by Myson Technology Inc.`
			`.Pp`
Assorted mdoc(7) fixes. Approved by: re (blanket) 2003-05-29 21:28:36 +00:00			`This manual page was written by`
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-26 21:46:14 +00:00			`.An Hiten M. Pandya Aq Mt hmp@FreeBSD.org .`
Add manual page for, Myson Technology PCI Ethernet Driver. PR: docs/39214 Reviewed by: bmah, julian, trhodes Approved by: des (mentor), re (scottl) 2003-05-18 19:02:38 +00:00			`.Sh BUGS`
			`The`
			`.Nm`
			`driver does not support Power Management Events (PME).`