[dpdk-dev] [vmxnet3 PATCH] doc: describe kernel dependency and --vmware-tsc-map

[Thomas Monjalon]

Be more verbose on kernel dependency about version and parameters.
And add description of DPDK parameter for VMware.

Signed-off-by: Thomas Monjalon <thomas.monjalon at 6wind.com>
---
 README.rst |   17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)

diff --git a/README.rst b/README.rst
index 55436a4..c718ec7 100644
--- a/README.rst
+++ b/README.rst
@@ -49,6 +49,9 @@ HOW TO BUILD
 
 There are two build dependencies: Linux kernel headers and DPDK >= 1.2.3r3.
 
+The kernel driver is based on vmxnet3-8.6.10 from VMware ESXi-5.0.0u2.
+So the latest supported Linux version is 3.2.
+
 DPDK must be built first in order to have all its header files in the same
 directory, that RTE_INCLUDE must point to.
 
@@ -93,15 +96,19 @@ Other parameters have a global effect:
 - ``num_rxds=int``: number of RX descriptors per queue
 - ``num_txds=int``: number of TX descriptors per queue
 
+Because the kernel module initializes interfaces, **it's very important that
+DPDK parameters match kernel ones**. It won't work otherwise.
+
 For more information, use ``modinfo vmxnet3-usermap.ko``.
 
-The values of the kernel module parameters must match the DPDK ones.
+In userland, librte_pmd_vmxnet3.so must be loaded by the DPDK using the ``-d``
+option.
 
-Because the kernel module initializes interfaces, it's very important that
-DPDK parameters match kernel ones. It won't work otherwise.
+Another interesting option is ``--vmware-tsc-map``.
+It allows VMware TSC mapping which provides an access to physical TSC.
+When this option is used, take care of setting this ESXi parameter::
 
-In userland, librte_pmd_vmxnet3.so must be loaded by the DPDK using the "-d"
-option.
+  monitor_control.pseudo_perfctr = TRUE
 
 ``testpmd`` example for two ports, matching the ``insmod`` command above::
 
-- 
1.7.10.4