xref: /freebsd/share/man/man4/enic.4 (revision 7ef62cebc2f965b0f640263e179276928885e33d)
1.\" Copyright 2008-2017 Cisco Systems, Inc.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS `AS IS' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd Sept 7, 2022
28.Dt ENIC 4
29.Os
30.Sh NAME
31.Nm enic
32.Nd "VIC Ethernet NIC driver"
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following lines in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device iflib"
39.Cd "device enic"
40.Ed
41.Pp
42To load the driver as a module at run-time,
43run the following command as root:
44.Bd -literal -offset indent
45kldload if_enic
46.Ed
47.Pp
48To load the driver as a
49module at boot time, place the following lines in
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52if_enic_load="YES"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57driver provides support for Cisco Virtual Interface Card.
58Support is limited to basic network connectivity.
59Media is controlled by the NIC itself since there can be multiple
60virtual PCI NIC devices exposed to the PCI bus.
61.Sh HARDWARE
62The
63.Nm
64driver should supports all known Cisco VIC cards.
65.Sh CONFIGURATION
66The
67.Nm
68network interface is configured using
69.Xr ifconfig 8
70and the
71.Xr sysctl 8
72tree at
73.Dv dev.enic.<N> .
74All configurable entries are also tunables, and can be put directly into the
75.Xr loader.conf 5
76for persistent configuration.
77.Sh SEE ALSO
78.Xr ifconfig 8
79.Sh HISTORY
80The
81.Nm
82device driver first appeared in
83.Fx 14.0 .
84.Sh AUTHORS
85.An -nosplit
86The
87.Nm
88driver was written by
89.An Cisco UCS team
90based of the DPDK driver.
91