xref: /freebsd/share/man/man4/mgb.4 (revision 783d3ff6d7fae619db8a7990b8a6387de0c677b5)
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.Dd September 28, 2021
25.Dt MGB 4
26.Os
27.Sh NAME
28.Nm mgb
29.Nd "Microchip LAN743x PCIe Gigabit Ethernet driver"
30.Sh SYNOPSIS
31To load the driver as a module at boot time, place the following line in
32.Xr loader.conf 5 :
33.Bd -literal -offset indent
34if_mgb_load="YES"
35.Ed
36.Sh DESCRIPTION
37The
38.Nm
39driver is experimental, and has a number of caveats and limitations.
40It is currently available only as a kernel module.
41.Pp
42The
43.Nm
44device driver provides support for PCIe Gigabit Ethernet adapters based on
45Microchip's LAN7430 and LAN7431.
46.Pp
47For more information on configuring this device, see
48.Xr ifconfig 8 .
49.Sh HARDWARE
50The
51.Nm
52driver supports:
53.Pp
54.Bl -bullet -compact
55.It
56Microchip LAN7430 PCIe Gigabit Ethernet controller with PHY
57.It
58Microchip LAN7431 PCIe Gigabit Ethernet controller with RGMII interface
59.El
60.Sh SEE ALSO
61.Xr arp 4 ,
62.Xr miibus 4 ,
63.Xr ifconfig 8
64.Sh CAVEATS
65The driver does not yet implement support for many hardware features,
66including:
67.Bl -bullet -compact
68.It
69Multiple RX queue support
70.It
71RX and TX checksum offload
72.It
73Hardware VLAN tagging or untagging
74.It
75Multicast receive packet filtering
76.It
77Wake on LAN (WoL)
78.It
79LSO
80.It
81RSS
82.El
83.Pp
84LAN7431 support is completely untested.
85