xref: /freebsd/share/man/man4/mgb.4 (revision 105fd928b0b5b35ab529e5f6914788dc49582901)
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 September 28, 2021
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
41driver is experimental, and has a number of caveats and limitations.
42It is currently available only as a kernel module.
43.Pp
44The
45.Nm
46device driver provides support for PCIe Gigabit Ethernet adapters based on
47Microchip's LAN7430 and LAN7431.
48.Pp
49For more information on configuring this device, see
50.Xr ifconfig 8 .
51.Sh HARDWARE
52The
53.Nm
54driver supports:
55.Pp
56.Bl -bullet -compact
57.It
58Microchip LAN7430 PCIe Gigabit Ethernet controller with PHY
59.It
60Microchip LAN7431 PCIe Gigabit Ethernet controller with RGMII interface
61.El
62.Sh SEE ALSO
63.Xr arp 4 ,
64.Xr miibus 4 ,
65.Xr ifconfig 8
66.Sh CAVEATS
67The driver does not yet implement support for many hardware features,
68including:
69.Bl -bullet -compact
70.It
71Multiple RX queue support
72.It
73RX and TX checksum offload
74.It
75Hardware VLAN tagging or untagging
76.It
77Multicast receive packet filtering
78.It
79Wake on LAN (WoL)
80.It
81LSO
82.It
83RSS
84.El
85.Pp
86LAN7431 support is completely untested.
87