Document which drivers are using MSI and how it can be disabled.
[dragonfly.git] / share / man / man4 / my.4
1 .\" Copyright (c) 2003 Hiten M. Pandya
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND ITS AND CONTRIBUTORS
14 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
15 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR THE CONTRIBUTORS
17 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
23 .\" POSSIBILITY OF SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/share/man/man4/my.4,v 1.7 2005/10/07 02:32:15 trhodes Exp $
26 .\" $DragonFly: src/share/man/man4/my.4,v 1.3 2007/03/11 03:46:48 swildner Exp $
27 .\"
28 .Dd July 16, 2005
29 .Dt MY 4
30 .Os
31 .Sh NAME
32 .Nm my
33 .Nd "Myson Technology Ethernet PCI driver"
34 .Sh SYNOPSIS
35 To compile this driver into the kernel,
36 place the following lines in your
37 kernel configuration file:
38 .Bd -ragged -offset indent
39 .Cd "device my"
40 .Ed
41 .Pp
42 Alternatively, to load the driver as a
43 module at boot time, place the following line in
44 .Xr loader.conf 5 :
45 .Bd -literal -offset indent
46 if_my_load="YES"
47 .Ed
48 .Sh DESCRIPTION
49 The
50 .Nm
51 driver provides support for various NICs based on the Myson chipset.
52 The Myson chipset is a variant of the DEC Tulip NIC chipset.
53 .Pp
54 The driver will work with almost any MII-compliant PHY, thus failure to
55 positively identify the chip is not a fatal error.
56 .Sh HARDWARE
57 The
58 .Nm
59 driver provides support for various NICs based on the Myson chipset.
60 Supported models include:
61 .Pp
62 .Bl -bullet -compact
63 .It
64 Myson MTD800 PCI Fast Ethernet chip
65 .It
66 Myson MTD803 PCI Fast Ethernet chip
67 .It
68 Myson MTD89X PCI Gigabit Ethernet chip
69 .El
70 .Sh SEE ALSO
71 .Xr de 4 ,
72 .Xr ifmedia 4 ,
73 .Xr netintro 4 ,
74 .Xr pci 4 ,
75 .Xr ifconfig 8
76 .Sh HISTORY
77 The
78 .Nm
79 driver first appeared in
80 .Fx 4.6 .
81 .Sh AUTHORS
82 The
83 .Nm
84 driver was written by Myson Technology Inc.
85 .Pp
86 This manual page was written by
87 .An Hiten M. Pandya Aq hmp@FreeBSD.org .
88 .Sh BUGS
89 The
90 .Nm
91 driver does not support Power Management Events (PME).