overview.rst revision 6b3e017e
1..  BSD LICENSE
2    Copyright 2016 6WIND S.A.
3
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7
8    * Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10    * Redistributions in binary form must reproduce the above copyright
11    notice, this list of conditions and the following disclaimer in
12    the documentation and/or other materials provided with the
13    distribution.
14    * Neither the name of 6WIND S.A. nor the names of its
15    contributors may be used to endorse or promote products derived
16    from this software without specific prior written permission.
17
18    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30Overview of Networking Drivers
31==============================
32
33The networking drivers may be classified in two categories:
34
35- physical for real devices
36- virtual for emulated devices
37
38Some physical devices may be shaped through a virtual layer as for
39SR-IOV.
40The interface seen in the virtual environment is a VF (Virtual Function).
41
42The ethdev layer exposes an API to use the networking functions
43of these devices.
44The bottom half part of ethdev is implemented by the drivers.
45Thus some features may not be implemented.
46
47There are more differences between drivers regarding some internal properties,
48portability or even documentation availability.
49Most of these differences are summarized below.
50
51.. _table_net_pmd_features:
52
53.. raw:: html
54
55   <style>
56      table#id1 th {
57         font-size: 80%;
58         white-space: pre-wrap;
59         text-align: center;
60         vertical-align: top;
61         padding: 2px;
62      }
63      table#id1 th:first-child {
64         vertical-align: bottom;
65      }
66      table#id1 td {
67         font-size: 70%;
68         padding: 1px;
69      }
70      table#id1 td:first-child {
71         padding-left: 1em;
72      }
73   </style>
74
75.. include:: overview_table.txt
76
77.. Note::
78
79   Features marked with "P" are partially supported. Refer to the appropriate
80   NIC guide in the following sections for details.
81