From patchwork Tue Jan 26 20:53:06 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 10100 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 477D89394; Tue, 26 Jan 2016 21:54:24 +0100 (CET) Received: from mail-wm0-f46.google.com (mail-wm0-f46.google.com [74.125.82.46]) by dpdk.org (Postfix) with ESMTP id D3E009267 for ; Tue, 26 Jan 2016 21:54:22 +0100 (CET) Received: by mail-wm0-f46.google.com with SMTP id l65so120841727wmf.1 for ; Tue, 26 Jan 2016 12:54:22 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id; bh=fAJJcnuuGftS6RESc9pYR0nWxFONpqOaPWvZt2dGUao=; b=hWlGyzDJL84vQiMeKA49XIqZaUnIs1n4V4PiqFKK7LGJM47V3zvVQka5LYv4mSCJE4 YXs7RuDz6wkLZoYvwQTOpOyTtxAPe0qWc4AKt1H9yw8lXKVyW7XhLacp63UbgMy7fclB ez+ZJP1jDWNzFkrfr9JbX3g0sMcv/24r1RZPCouq1cw/PaCOEjEI4DnkD+t5PqDPrru2 JkVtSleAbWmgDX6+VvhHD1i0OypDaEunLO5Q+TCAKCCoQtxS8NaCfcEVjeUXMuASc3dt q3DD9c3STz7hBy6rzqlPac+xYWzB4LCu48RsojTTuBfgStSq81fA45/HgDP+BZo7o922 Cqrw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=fAJJcnuuGftS6RESc9pYR0nWxFONpqOaPWvZt2dGUao=; b=FCle4w9bWkyIVFPkR02U9UNLeDPebgkY5C2jVJqwjcK0BGnQsPiguKuIiOzc2jvOrT BG0YptZEqJw2le07JYXr1Ivw7JsuO2lP22M9e6m0gmInjqXFGK34Imj7CTuafAWCSKJr m62vFZX4mO7KXHfY6oSXMwrOePPl0WnlcZ8IG9dAJnD2iOy2qvq2GmaKCWy7/iPRxMGq C9MR0f96KOVF7VBPl4Dnzn/PTwQPxj1TSNf1cFWww01vy68rB8z78XEHz2TdZOrZaiA6 DzSZZK7c1R0JspqxGPkdylnS9Sh7bCF5kUdS/UGKUx4FRT59BXlbxElMCTccYk8X7faM Kf+g== X-Gm-Message-State: AG10YOSRvKBOqaA9ubnkbaOJx1CKIRCwLaLFzKx25468lZzsOY6/iwSziAV/IbAupG6tL/qJ X-Received: by 10.28.107.152 with SMTP id a24mr28236359wmi.101.1453841662666; Tue, 26 Jan 2016 12:54:22 -0800 (PST) Received: from localhost.localdomain (136-92-190-109.dsl.ovh.fr. [109.190.92.136]) by smtp.gmail.com with ESMTPSA id js8sm3045577wjc.37.2016.01.26.12.54.21 (version=TLSv1/SSLv3 cipher=OTHER); Tue, 26 Jan 2016 12:54:21 -0800 (PST) From: Thomas Monjalon To: John McNamara Date: Tue, 26 Jan 2016 21:53:06 +0100 Message-Id: <1453841586-27747-1-git-send-email-thomas.monjalon@6wind.com> X-Mailer: git-send-email 2.5.2 Cc: dev@dpdk.org Subject: [dpdk-dev] [PATCH] doc: introduce networking driver matrix X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" In order to better compare the drivers and check what is missing for a common baseline, we need to fill a matrix. A CSS trick is used to fit the HTML page. The PDF output needs some LaTeX wizardry. Signed-off-by: Thomas Monjalon --- doc/guides/nics/index.rst | 1 + doc/guides/nics/overview.rst | 145 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 146 insertions(+) create mode 100644 doc/guides/nics/overview.rst diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index 33c9cea..8618114 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -35,6 +35,7 @@ Network Interface Controller Drivers :maxdepth: 3 :numbered: + overview bnx2x cxgbe e1000em diff --git a/doc/guides/nics/overview.rst b/doc/guides/nics/overview.rst new file mode 100644 index 0000000..e00f094 --- /dev/null +++ b/doc/guides/nics/overview.rst @@ -0,0 +1,145 @@ +.. BSD LICENSE + Copyright 2016 6WIND S.A. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of 6WIND S.A. nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +Overview of Networking Drivers +============================== + +The networking drivers may be classified in two categories: + +- physical for real devices +- virtual for emulated devices + +Some physical devices may be shaped through a virtual layer as for +SR-IOV. +The interface seen in the virtual environment is a VF (Virtual Function). + +The ethdev layer exposes an API to use the networking functions +of these devices. +The bottom half part of ethdev is implemented by the drivers. +Thus some features may not be implemented. + +There are more differences between drivers regarding some internal properties, +portability or even documentation availability. +Most of these differences are summarized below. + +.. _table_net_pmd_features: + +.. raw:: html + + + +.. table:: Features availability in networking drivers + + ==================== = = = = = = = = = = = = = = = = = = = = = = = = = + Feature a b b b c e e i i i i i i f m m m n n p r s v v x + f n n o x 1 n 4 4 g g x x m l l p f u c i z i m e + p x x n g 0 i 0 0 b b g g 1 x x i p l a n e r x n + a 2 2 d b 0 c e e v b b 0 4 5 p l p g d t n v + c x x i e 0 v f e e k e a i e i + k v n f v t o t r + e f g f a 3 t + t 2 + ==================== = = = = = = = = = = = = = = = = = = = = = = = = = + link status + link status event + Rx interrupt + queue start/stop + MTU update + jumbo frame + scattered Rx + LRO + TSO + promiscuous mode + allmulticast mode + unicast MAC filter + multicast MAC filter + RSS hash + RSS key update + RSS reta update + VMDq + SR-IOV + DCB + VLAN filter + ethertype filter + n-tuple filter + SYN filter + tunnel filter + flexible filter + hash filter + flow director + flow control + rate limitation + traffic mirroring + CRC offload + VLAN offload + QinQ offload + L3 checksum offload + L4 checksum offload + inner L3 checksum + inner L4 checksum + packet type parsing + timesync + basic stats + extended stats + stats per queue + EEPROM dump + registers dump + multiprocess aware + BSD nic_uio + Linux UIO + Linux VFIO + other kdrv + ARMv7 + ARMv8 + Power8 + TILE-Gx + x86-32 + x86-64 + usage doc + design doc + perf doc + ==================== = = = = = = = = = = = = = = = = = = = = = = = = =