xref: /freebsd/share/man/man4/man4.aarch64/enetc.4 (revision 911f0260390e18cf85f3dbf2c719b593efdc1e3c)
1.\" -
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2021 Alstom Group.
5.\" Copyright (c) 2021 Semihalf.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd June 11, 2021
28.Dt ENETC 4
29.Os
30.Sh NAME
31.Nm enetc
32.Nd "Freescale ENETC PCIe Gigabit Ethernet driver"
33.Sh SYNOPSIS
34To compile this driver into the kernel the following lines must be present
35in the kernel configuration file:
36.sp
37.Cd "options SOC_NXP_LS"
38.Cd "device pci"
39.Cd "device fdt"
40.Cd "device iflib"
41.Cd "device enetc"
42.Sh DESCRIPTION
43The
44.Nm
45driver provides support for ENETC Gigabit Ethernet NIC found in LS1028A SoC.
46.Xr iflib 9
47is used to communicate with the rest of kernel.
48Both physical ports, as well as virtual interfaces connected to the internal
49switch are supported.
50.Pp
51The following hardware offloads have been implemented in this version
52of the driver:
53.Bd -literal
54- Receive IP checksum validation.
55- VLAN tag insertion and extraction.
56- VLAN tag based packet filtering.
57.Ed
58.Pp
59For more information about configuring this device refer to
60.Xr ifconfig 8 .
61.Sh SEE ALSO
62.Xr vlan 4 ,
63.Xr ifconfig 8 ,
64.Xr iflib 9
65.Sh HISTORY
66The
67.Nm
68driver first appeared in
69.Fx 14.0 .
70