vhost: add user callbacks for socket open/close

[dpdk.git] / doc / guides / nics / dpaa2.rst

diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst
index 46225b6..d6b1f21 100644 (file)
--- a/doc/guides/nics/dpaa2.rst
+++ b/doc/guides/nics/dpaa2.rst
@@ -1,6 +1,5 @@
 ..  BSD LICENSE
 ..  BSD LICENSE

-    Copyright (C) NXP. 2016.
-    All rights reserved.
+    Copyright 2016 NXP.

 
     Redistribution and use in source and binary forms, with or without
     modification, are permitted provided that the following conditions
 
     Redistribution and use in source and binary forms, with or without
     modification, are permitted provided that the following conditions


@@ -49,6 +48,8 @@ Contents summary
 - Overview of DPAA2 objects
 - DPAA2 driver architecture overview
 
 - Overview of DPAA2 objects
 - DPAA2 driver architecture overview
 

+.. _dpaa2_overview:
+

 DPAA2 Overview
 ~~~~~~~~~~~~~~
 
 DPAA2 Overview
 ~~~~~~~~~~~~~~
 


@@ -421,9 +422,15 @@ Features of the DPAA2 PMD are:
 
 - Multiple queues for TX and RX
 - Receive Side Scaling (RSS)
 
 - Multiple queues for TX and RX
 - Receive Side Scaling (RSS)

+- MAC/VLAN filtering

 - Packet type information
 - Checksum offload
 - Promiscuous mode
 - Packet type information
 - Checksum offload
 - Promiscuous mode

+- Multicast mode
+- Port hardware statistics
+- Jumbo frames
+- Link flow control
+- Scattered and gather for TX and RX

 
 Supported DPAA2 SoCs
 --------------------
 
 Supported DPAA2 SoCs
 --------------------


@@ -471,12 +478,12 @@ separately:
 
   SDK and related information can be obtained from:  `NXP QorIQ SDK  <http://www.nxp.com/products/software-and-tools/run-time-software/linux-sdk/linux-sdk-for-qoriq-processors:SDKLINUX>`_.
 
 
   SDK and related information can be obtained from:  `NXP QorIQ SDK  <http://www.nxp.com/products/software-and-tools/run-time-software/linux-sdk/linux-sdk-for-qoriq-processors:SDKLINUX>`_.
 

-- **DPDK Helper Scripts**
+- **DPDK Extra Scripts**

 
   DPAA2 based resources can be configured easily with the help of ready scripts
 
   DPAA2 based resources can be configured easily with the help of ready scripts

-  as provided in the DPDK helper repository.
+  as provided in the DPDK Extra repository.

 
 

-  `DPDK Helper Scripts <https://github.com/qoriq-open-source/dpdk-helper>`_.
+  `DPDK Extras Scripts <https://github.com/qoriq-open-source/dpdk-extras>`_.

 
 Currently supported by DPDK:
 
 
 Currently supported by DPDK:
 


@@ -534,67 +541,46 @@ Please note that enabling debugging options may affect system performance.
 
   Toggle display of transmit fast path buffer free run-time message
 
 
   Toggle display of transmit fast path buffer free run-time message
 

+Driver compilation and testing
+------------------------------

 
 

-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the DPAA2 PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa2-linuxapp-gcc install
-
-.. _dpaa2_testpmd_example:
-
-Running testpmd
-~~~~~~~~~~~~~~~
-
-This section demonstrates how to launch ``testpmd`` with DPAA2 device
-managed by ``librte_pmd_dpaa2`` in the Linux operating system.
-
-#. Configure the resource container:
-
-   Configure resources in MC and create the DPRC container:
+Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
+for details.

 
 

-   .. code-block:: console
+#. Running testpmd:

 
 

-      export the DPRC container
-      e.g. export DPRCT=dprc.2
+   Follow instructions available in the document
+   :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
+   to run testpmd.

 
 

-#. Start ``testpmd`` with basic parameters:
+   Example output:

 
    .. code-block:: console
 
       ./arm64-dpaa2-linuxapp-gcc/testpmd -c 0xff -n 1 \
         -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx
 
 
    .. code-block:: console
 
       ./arm64-dpaa2-linuxapp-gcc/testpmd -c 0xff -n 1 \
         -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx
 

-   Example output:
-
-   .. code-block:: console
-
-        .....
-        EAL: Registered [pci] bus.
-        EAL: Registered [fslmc] bus.
-        EAL: Detected 8 lcore(s)
-        EAL: Probing VFIO support...
-        EAL: VFIO support initialized
-        .....
-        PMD: DPAA2: Processing Container = dprc.2
-        EAL: fslmc: DPRC contains = 51 devices
-        EAL: fslmc: Bus scan completed
-        .....
-        Configuring Port 0 (socket 0)
-        Port 0: 00:00:00:00:00:01
-        Configuring Port 1 (socket 0)
-        Port 1: 00:00:00:00:00:02
-        .....
-        Checking link statuses...
-        Port 0 Link Up - speed 10000 Mbps - full-duplex
-        Port 1 Link Up - speed 10000 Mbps - full-duplex
-        Done
-        testpmd>
+      .....
+      EAL: Registered [pci] bus.
+      EAL: Registered [fslmc] bus.
+      EAL: Detected 8 lcore(s)
+      EAL: Probing VFIO support...
+      EAL: VFIO support initialized
+      .....
+      PMD: DPAA2: Processing Container = dprc.2
+      EAL: fslmc: DPRC contains = 51 devices
+      EAL: fslmc: Bus scan completed
+      .....
+      Configuring Port 0 (socket 0)
+      Port 0: 00:00:00:00:00:01
+      Configuring Port 1 (socket 0)
+      Port 1: 00:00:00:00:00:02
+      .....
+      Checking link statuses...
+      Port 0 Link Up - speed 10000 Mbps - full-duplex
+      Port 1 Link Up - speed 10000 Mbps - full-duplex
+      Done
+      testpmd>

 
 Limitations
 -----------
 
 Limitations
 -----------


@@ -611,3 +597,10 @@ The DPAA2 SoC family support a maximum of a 10240 jumbo frame. The value
 is fixed and cannot be changed. So, even when the ``rxmode.max_rx_pkt_len``
 member of ``struct rte_eth_conf`` is set to a value lower than 10240, frames
 up to 10240 bytes can still reach the host interface.
 is fixed and cannot be changed. So, even when the ``rxmode.max_rx_pkt_len``
 member of ``struct rte_eth_conf`` is set to a value lower than 10240, frames
 up to 10240 bytes can still reach the host interface.

+
+Other Limitations
+~~~~~~~~~~~~~~~~~
+
+- RSS hash key cannot be modified.
+- RSS RETA cannot be configured.
+- Secondary process packet I/O is not supported.