szedata2.rst revision 97f17497
1..  BSD LICENSE
2    Copyright 2015 - 2016 CESNET
3    All rights reserved.
4
5    Redistribution and use in source and binary forms, with or without
6    modification, are permitted provided that the following conditions
7    are met:
8
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
14    distribution.
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.
18
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.
30
31SZEDATA2 poll mode driver library
32=================================
33
34The SZEDATA2 poll mode driver library implements support for cards from COMBO
35family (**COMBO-80G**, **COMBO-100G**).
36The SZEDATA2 PMD uses interface provided by libsze2 library to communicate
37with COMBO cards over sze2 layer.
38
39More information about family of
40`COMBO cards <https://www.liberouter.org/technologies/cards/>`_
41and used technology
42(`NetCOPE platform <https://www.liberouter.org/technologies/netcope/>`_) can be
43found on the `Liberouter website <https://www.liberouter.org/>`_.
44
45.. note::
46
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``
50   and recompiling.
51
52.. note::
53
54   Currently the driver is supported only on x86_64 architectures.
55   Only x86_64 versions of the external libraries are provided.
56
57Prerequisites
58-------------
59
60This PMD requires kernel modules which are responsible for initialization and
61allocation of resources needed for sze2 layer function.
62Communication between PMD and kernel modules is mediated by libsze2 library.
63These kernel modules and library are not part of DPDK and must be installed
64separately:
65
66*  **libsze2 library**
67
68   The library provides API for initialization of sze2 transfers, receiving and
69   transmitting data segments.
70
71*  **Kernel modules**
72
73   * combov3
74   * szedata2_cv3
75
76   Kernel modules manage initialization of hardware, allocation and
77   sharing of resources for user space applications.
78
79Information about getting the dependencies can be found `here
80<https://www.liberouter.org/technologies/netcope/access-to-libsze2-library/>`_.
81
82Configuration
83-------------
84
85These configuration options can be modified before compilation in the
86``.config`` file:
87
88*  ``CONFIG_RTE_LIBRTE_PMD_SZEDATA2`` default value: **n**
89
90   Value **y** enables compilation of szedata2 PMD.
91
92*  ``CONFIG_RTE_LIBRTE_PMD_SZEDATA2_AS`` default value: **0**
93
94   This option defines type of firmware address space.
95   Currently supported value is:
96
97   * **0** for firmwares:
98
99      * NIC_100G1_LR4
100      * HANIC_100G1_LR4
101      * HANIC_100G1_SR10
102
103Using the SZEDATA2 PMD
104----------------------
105
106From DPDK version 16.04 the type of SZEDATA2 PMD is changed to PMD_PDEV.
107SZEDATA2 device is automatically recognized during EAL initialization.
108No special command line options are needed.
109
110Kernel modules have to be loaded before running the DPDK application.
111
112Example of usage
113----------------
114
115Read packets from 0. and 1. receive channel and write them to 0. and 1.
116transmit channel:
117
118.. code-block:: console
119
120   $RTE_TARGET/app/testpmd -c 0xf -n 2 \
121   -- --port-topology=chained --rxq=2 --txq=2 --nb-cores=2 -i -a
122
123Example output:
124
125.. code-block:: console
126
127   [...]
128   EAL: PCI device 0000:06:00.0 on NUMA socket -1
129   EAL:   probe driver: 1b26:c1c1 rte_szedata2_pmd
130   PMD: Initializing szedata2 device (0000:06:00.0)
131   PMD: SZEDATA2 path: /dev/szedataII0
132   PMD: Available DMA channels RX: 8 TX: 8
133   PMD: resource0 phys_addr = 0xe8000000 len = 134217728 virt addr = 7f48f8000000
134   PMD: szedata2 device (0000:06:00.0) successfully initialized
135   Interactive-mode selected
136   Auto-start selected
137   Configuring Port 0 (socket 0)
138   Port 0: 00:11:17:00:00:00
139   Checking link statuses...
140   Port 0 Link Up - speed 10000 Mbps - full-duplex
141   Done
142   Start automatic packet forwarding
143     io packet forwarding - CRC stripping disabled - packets/burst=32
144     nb forwarding cores=2 - nb forwarding ports=1
145     RX queues=2 - RX desc=128 - RX free threshold=0
146     RX threshold registers: pthresh=0 hthresh=0 wthresh=0
147     TX queues=2 - TX desc=512 - TX free threshold=0
148     TX threshold registers: pthresh=0 hthresh=0 wthresh=0
149     TX RS bit threshold=0 - TXQ flags=0x0
150   testpmd>
151