xref: /freebsd/share/man/man4/enic.4 (revision e0c4386e7e71d93b0edc0c8fa156263fc4a8b0b6)
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.Dd Sept 7, 2022
26.Dt ENIC 4
27.Os
28.Sh NAME
29.Nm enic
30.Nd "VIC Ethernet NIC driver"
31.Sh SYNOPSIS
32To compile this driver into the kernel,
33place the following lines in your
34kernel configuration file:
35.Bd -ragged -offset indent
36.Cd "device iflib"
37.Cd "device enic"
38.Ed
39.Pp
40To load the driver as a module at run-time,
41run the following command as root:
42.Bd -literal -offset indent
43kldload if_enic
44.Ed
45.Pp
46To load the driver as a
47module at boot time, place the following lines in
48.Xr loader.conf 5 :
49.Bd -literal -offset indent
50if_enic_load="YES"
51.Ed
52.Sh DESCRIPTION
53The
54.Nm
55driver provides support for Cisco Virtual Interface Card.
56Support is limited to basic network connectivity.
57Media is controlled by the NIC itself since there can be multiple
58virtual PCI NIC devices exposed to the PCI bus.
59.Sh HARDWARE
60The
61.Nm
62driver should supports all known Cisco VIC cards.
63.Sh CONFIGURATION
64The
65.Nm
66network interface is configured using
67.Xr ifconfig 8
68and the
69.Xr sysctl 8
70tree at
71.Dv dev.enic.<N> .
72All configurable entries are also tunables, and can be put directly into the
73.Xr loader.conf 5
74for persistent configuration.
75.Sh SEE ALSO
76.Xr ifconfig 8
77.Sh HISTORY
78The
79.Nm
80device driver first appeared in
81.Fx 14.0 .
82.Sh AUTHORS
83.An -nosplit
84The
85.Nm
86driver was written by
87.An Cisco UCS team
88based of the DPDK driver.
89