xref: /freebsd/share/man/man4/mgb.4 (revision 732a02b4e77866604a120a275c082bb6221bd2ff)
1.\" Copyright (c) 2019 The FreeBSD Foundation.
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\"    notice, this list of conditions and the following disclaimer in the
10.\"    documentation and/or other materials provided with the distribution.
11.\"
12.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22.\" SUCH DAMAGE.
23.\"
24.\" $FreeBSD$
25.\"
26.Dd May 2, 2019
27.Dt MGB 4
28.Os
29.Sh NAME
30.Nm mgb
31.Nd "Microchip LAN743x PCIe Gigabit Ethernet driver"
32.Sh SYNOPSIS
33To load the driver as a module at boot time, place the following line in
34.Xr loader.conf 5 :
35.Bd -literal -offset indent
36if_mgb_load="YES"
37.Ed
38.Sh DESCRIPTION
39The
40.Nm
41device driver provides support for PCIe Gigabit Ethernet adapters based on
42Microchip's LAN7430 and LAN7431.
43.Pp
44For more information on configuring this device, see
45.Xr ifconfig 8 .
46.Sh HARDWARE
47The
48.Nm
49driver supports:
50.Pp
51.Bl -bullet -compact
52.It
53Microchip LAN7430 PCIe Gigabit Ethernet controller with PHY
54.It
55Microchip LAN7431 PCIe Gigabit Ethernet controller with RGMII interface
56.El
57.Sh SEE ALSO
58.Xr arp 4 ,
59.Xr miibus 4 ,
60.Xr ifconfig 8
61.Sh CAVEATS
62The driver does not yet implement support for many hardware features,
63including:
64.Bl -bullet -compact
65.It
66Multiple RX queue support
67.It
68RX and TX checksum offload
69.It
70Hardware VLAN tagging or untagging
71.It
72Multicast receive packet filtering
73.It
74Wake on LAN (WoL)
75.It
76LSO
77.It
78RSS
79.El
80.Pp
81LAN7431 support is completely untested.
82.Sh HISTORY
83The
84.Nm
85device driver first appeared in
86.Fx 13.0 .
87