net/mlx5: support power monitoring
[dpdk.git] / doc / guides / nics / vdev_netvsc.rst
index f779862..5c1dcbf 100644 (file)
@@ -1,11 +1,11 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
     Copyright 2017 6WIND S.A.
-    Copyright 2017 Mellanox Technologies, Ltd.
+    Copyright 2017 Mellanox Technologies, Ltd
 
 VDEV_NETVSC driver
 ==================
 
-The VDEV_NETVSC driver (librte_pmd_vdev_netvsc) provides support for NetVSC
+The VDEV_NETVSC driver (**librte_net_vdev_netvsc**) provides support for NetVSC
 interfaces and associated SR-IOV virtual function (VF) devices found in
 Linux virtual machines running on Microsoft Hyper-V_ (including Azure)
 platforms.
@@ -61,18 +61,12 @@ This driver implementation may be temporary and should be improved or removed
 either when hot-plug will be fully supported in EAL and bus drivers or when
 a new NetVSC driver will be integrated.
 
-Build options
--------------
-
-- ``CONFIG_RTE_LIBRTE_VDEV_NETVSC_PMD`` (default ``y``)
-
-   Toggle compilation of this driver.
 
 Run-time parameters
 -------------------
 
-To invoke this driver, applications have to explicitly provide the
-``--vdev=net_vdev_netvsc`` EAL option.
+This driver is invoked automatically in Hyper-V VM systems unless the user
+invoked it by command line using ``--vdev=net_vdev_netvsc`` EAL option.
 
 The following device parameters are supported:
 
@@ -86,5 +80,19 @@ The following device parameters are supported:
   Same as ``iface`` except a suitable NetVSC interface is located using its
   MAC address.
 
-Not specifying either ``iface`` or ``mac`` makes this driver attach itself to
-all unrouted NetVSC interfaces found on the system.
+- ``force`` [int]
+
+  If nonzero, forces the use of specified interfaces even if not detected as
+  NetVSC.
+
+- ``ignore`` [int]
+
+  If nonzero, ignores the driver running (actually used to disable the
+  auto-detection in Hyper-V VM).
+
+.. note::
+
+   Not specifying either ``iface`` or ``mac`` makes this driver attach itself to
+   all unrouted NetVSC interfaces found on the system.
+   Specifying the device makes this driver attach itself to the device
+   regardless the device routes.