doc/guides/nics/overview.rst

   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
  30 Overview of Networking Drivers
  31 ==============================
  32
  33 The networking drivers may be classified in two categories:
  34
  35 - physical for real devices
  36 - virtual for emulated devices
  37
  38 Some physical devices may be shaped through a virtual layer as for
  39 SR-IOV.
  40 The interface seen in the virtual environment is a VF (Virtual Function).
  41
  42 The ethdev layer exposes an API to use the networking functions
  43 of these devices.
  44 The bottom half part of ethdev is implemented by the drivers.
  45 Thus some features may not be implemented.
  46
  47 There are more differences between drivers regarding some internal properties,
  48 portability or even documentation availability.
  49 Most 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: 3px;
  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 .. table:: Features availability in networking drivers
  76
  77    ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
  78    Feature              a b b b c e e i i i i i i i i i i f f m m m n n p r s v v v x
  79                         f n n o x 1 n 4 4 4 4 g g x x x x m m l l p f u c i z i i m e
  80                         p x x n g 0 i 0 0 0 0 b b g g g g 1 1 x x i p l a n e r r x n
  81                         a 2 2 d b 0 c e e e e   v b b b b 0 0 4 5 p   l p g d t t n v
  82                         c x x i e 0     . v v   f e e e e k k     e         a i i e i
  83                         k   v n         . f f       . v v   .               t o o t r
  84                         e   f g         .   .       . f f   .               a   . 3 t
  85                         t               v   v       v   v   v               2   v
  86                                         e   e       e   e   e                   e
  87                                         c   c       c   c   c                   c
  88    ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
  89    link status
  90    link status event
  91    Rx interrupt
  92    queue start/stop
  93    MTU update
  94    jumbo frame
  95    scattered Rx
  96    LRO
  97    TSO
  98    promiscuous mode
  99    allmulticast mode
 100    unicast MAC filter
 101    multicast MAC filter
 102    RSS hash
 103    RSS key update
 104    RSS reta update
 105    VMDq
 106    SR-IOV
 107    DCB
 108    VLAN filter
 109    ethertype filter
 110    n-tuple filter
 111    SYN filter
 112    tunnel filter
 113    flexible filter
 114    hash filter
 115    flow director
 116    flow control
 117    rate limitation
 118    traffic mirroring
 119    CRC offload
 120    VLAN offload
 121    QinQ offload
 122    L3 checksum offload
 123    L4 checksum offload
 124    inner L3 checksum
 125    inner L4 checksum
 126    packet type parsing
 127    timesync
 128    basic stats
 129    extended stats
 130    stats per queue
 131    EEPROM dump
 132    registers dump
 133    multiprocess aware
 134    BSD nic_uio
 135    Linux UIO
 136    Linux VFIO
 137    other kdrv
 138    ARMv7
 139    ARMv8
 140    Power8
 141    TILE-Gx
 142    x86-32
 143    x86-64
 144    usage doc
 145    design doc
 146    perf doc
 147    ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =