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