5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above copyright
12 notice, this list of conditions and the following disclaimer in
13 the documentation and/or other materials provided with the
15 * Neither the name of CESNET nor the names of its
16 contributors may be used to endorse or promote products derived
17 from this software without specific prior written permission.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 SZEDATA2 poll mode driver library
32 =================================
34 The SZEDATA2 poll mode driver library implements support for cards from COMBO
35 family (**COMBO-80G**, **COMBO-100G**).
36 The SZEDATA2 PMD is virtual PMD which uses interface provided by libsze2
37 library to communicate with COMBO cards over sze2 layer.
39 More information about family of
40 `COMBO cards <https://www.liberouter.org/technologies/cards/>`_
42 (`NetCOPE platform <https://www.liberouter.org/technologies/netcope/>`_) can be
43 found on the `Liberouter website <https://www.liberouter.org/>`_.
47 This driver has external dependencies.
48 Therefore it is disabled in default configuration files.
49 It can be enabled by setting ``CONFIG_RTE_LIBRTE_PMD_SZEDATA2=y``
54 Currently the driver is supported only on x86_64 architectures.
55 Only x86_64 versions of the external libraries are provided.
60 This PMD requires kernel modules which are responsible for initialization and
61 allocation of resources needed for sze2 layer function.
62 Communication between PMD and kernel modules is mediated by libsze2 library.
63 These kernel modules and library are not part of DPDK and must be installed
68 The library provides API for initialization of sze2 transfers, receiving and
69 transmitting data segments.
76 Kernel modules manage initialization of hardware, allocation and
77 sharing of resources for user space applications:
79 Information about getting the dependencies can be found `here
80 <https://www.liberouter.org/technologies/netcope/access-to-libsze2-library/>`_.
83 Using the SZEDATA2 PMD
84 ----------------------
86 SZEDATA2 PMD can be created by passing ``--vdev=`` option to EAL in the
89 .. code-block:: console
91 --vdev 'DEVICE,dev_path=PATH,rx_ifaces=RX_MASK,tx_ifaces=TX_MASK'
93 ``DEVICE`` and options ``dev_path``, ``rx_ifaces``, ``tx_ifaces`` are mandatory
94 and must be separated by commas.
96 * ``DEVICE``: contains prefix ``eth_szedata2`` followed by numbers or letters,
97 must be unique for each virtual device
99 * ``dev_path``: Defines path to szedata2 device.
100 Value is valid path to szedata2 device. Example:
102 .. code-block:: console
104 dev_path=/dev/szedataII0
106 * ``rx_ifaces``: Defines which receive channels will be used.
107 For each channel is created one queue. Value is mask for selecting which
108 receive channels are required. Example:
110 .. code-block:: console
114 * ``tx_ifaces``: Defines which transmit channels will be used.
115 For each channel is created one queue. Value is mask for selecting which
116 transmit channels are required. Example:
118 .. code-block:: console
125 Read packets from 0. and 1. receive channel and write them to 0. and 1.
128 .. code-block:: console
130 $RTE_TARGET/app/testpmd -c 0xf -n 2 \
131 --vdev 'eth_szedata20,dev_path=/dev/szedataII0,rx_ifaces=0x3,tx_ifaces=0x3' \
132 -- --port-topology=chained --rxq=2 --txq=2 --nb-cores=2