xref: /freebsd/share/man/man4/enic.4 (revision b74aaa1a2199261f9078247d29481a994b6b5e42)
19c067b84SDoug Ambrisko.\" Copyright 2008-2017 Cisco Systems, Inc.
29c067b84SDoug Ambrisko.\" All rights reserved.
39c067b84SDoug Ambrisko.\"
49c067b84SDoug Ambrisko.\" Redistribution and use in source and binary forms, with or without
59c067b84SDoug Ambrisko.\" modification, are permitted provided that the following conditions
69c067b84SDoug Ambrisko.\" are met:
79c067b84SDoug Ambrisko.\" 1. Redistributions of source code must retain the above copyright
89c067b84SDoug Ambrisko.\"    notice, this list of conditions and the following disclaimer.
99c067b84SDoug Ambrisko.\" 2. Redistributions in binary form must reproduce the above copyright
109c067b84SDoug Ambrisko.\"    notice, this list of conditions and the following disclaimer in the
119c067b84SDoug Ambrisko.\"    documentation and/or other materials provided with the distribution.
129c067b84SDoug Ambrisko.\"
139c067b84SDoug Ambrisko.\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS `AS IS' AND
149c067b84SDoug Ambrisko.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
159c067b84SDoug Ambrisko.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
169c067b84SDoug Ambrisko.\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
179c067b84SDoug Ambrisko.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
189c067b84SDoug Ambrisko.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
199c067b84SDoug Ambrisko.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
209c067b84SDoug Ambrisko.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
219c067b84SDoug Ambrisko.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
229c067b84SDoug Ambrisko.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
239c067b84SDoug Ambrisko.\" SUCH DAMAGE.
249c067b84SDoug Ambrisko.\"
25*b74aaa1aSGraham Percival.Dd September 7, 2022
269c067b84SDoug Ambrisko.Dt ENIC 4
279c067b84SDoug Ambrisko.Os
289c067b84SDoug Ambrisko.Sh NAME
299c067b84SDoug Ambrisko.Nm enic
309c067b84SDoug Ambrisko.Nd "VIC Ethernet NIC driver"
319c067b84SDoug Ambrisko.Sh SYNOPSIS
329c067b84SDoug AmbriskoTo compile this driver into the kernel,
339c067b84SDoug Ambriskoplace the following lines in your
349c067b84SDoug Ambriskokernel configuration file:
359c067b84SDoug Ambrisko.Bd -ragged -offset indent
369c067b84SDoug Ambrisko.Cd "device iflib"
379c067b84SDoug Ambrisko.Cd "device enic"
389c067b84SDoug Ambrisko.Ed
399c067b84SDoug Ambrisko.Pp
409c067b84SDoug AmbriskoTo load the driver as a module at run-time,
419c067b84SDoug Ambriskorun the following command as root:
429c067b84SDoug Ambrisko.Bd -literal -offset indent
439c067b84SDoug Ambriskokldload if_enic
449c067b84SDoug Ambrisko.Ed
459c067b84SDoug Ambrisko.Pp
469c067b84SDoug AmbriskoTo load the driver as a
479c067b84SDoug Ambriskomodule at boot time, place the following lines in
489c067b84SDoug Ambrisko.Xr loader.conf 5 :
499c067b84SDoug Ambrisko.Bd -literal -offset indent
509c067b84SDoug Ambriskoif_enic_load="YES"
519c067b84SDoug Ambrisko.Ed
529c067b84SDoug Ambrisko.Sh DESCRIPTION
539c067b84SDoug AmbriskoThe
549c067b84SDoug Ambrisko.Nm
556957cd86SKonstantin Belousovdriver provides support for Cisco Virtual Interface Card.
566957cd86SKonstantin BelousovSupport is limited to basic network connectivity.
576957cd86SKonstantin BelousovMedia is controlled by the NIC itself since there can be multiple
586957cd86SKonstantin Belousovvirtual PCI NIC devices exposed to the PCI bus.
599c067b84SDoug Ambrisko.Sh HARDWARE
609c067b84SDoug AmbriskoThe
619c067b84SDoug Ambrisko.Nm
629c067b84SDoug Ambriskodriver should supports all known Cisco VIC cards.
639c067b84SDoug Ambrisko.Sh CONFIGURATION
649c067b84SDoug AmbriskoThe
659c067b84SDoug Ambrisko.Nm
669c067b84SDoug Ambriskonetwork interface is configured using
679c067b84SDoug Ambrisko.Xr ifconfig 8
689c067b84SDoug Ambriskoand the
699c067b84SDoug Ambrisko.Xr sysctl 8
709c067b84SDoug Ambriskotree at
719c067b84SDoug Ambrisko.Dv dev.enic.<N> .
729c067b84SDoug AmbriskoAll configurable entries are also tunables, and can be put directly into the
739c067b84SDoug Ambrisko.Xr loader.conf 5
749c067b84SDoug Ambriskofor persistent configuration.
759c067b84SDoug Ambrisko.Sh SEE ALSO
769c067b84SDoug Ambrisko.Xr ifconfig 8
779c067b84SDoug Ambrisko.Sh HISTORY
789c067b84SDoug AmbriskoThe
799c067b84SDoug Ambrisko.Nm
809c067b84SDoug Ambriskodevice driver first appeared in
819c067b84SDoug Ambrisko.Fx 14.0 .
829c067b84SDoug Ambrisko.Sh AUTHORS
839c067b84SDoug Ambrisko.An -nosplit
849c067b84SDoug AmbriskoThe
859c067b84SDoug Ambrisko.Nm
869c067b84SDoug Ambriskodriver was written by
879c067b84SDoug Ambrisko.An Cisco UCS team
889c067b84SDoug Ambriskobased of the DPDK driver.
89