doc: add ThunderX nicvf
[dpdk.git] / doc / guides / nics / overview.rst
index 62f1868..286fe00 100644 (file)
@@ -58,7 +58,7 @@ Most of these differences are summarized below.
          white-space: pre-wrap;
          text-align: center;
          vertical-align: top;
-         padding: 3px;
+         padding: 2px;
       }
       table#id1 th:first-child {
          vertical-align: bottom;
@@ -74,76 +74,81 @@ Most of these differences are summarized below.
 
 .. table:: Features availability in networking drivers
 
-   ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
-   Feature              a b b b c e 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 v x
-                        f n n o x 1 n n 4 4 4 4 g g x x x x m m l l p f u c i z h i i m e
-                        p x x n g 0 a i 0 0 0 0 b b g g g g 1 1 x x i p l a n e o r r x n
-                        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 s t t n v
-                        c x x i e 0       . v v   f e e e e k k     e         a t i i e i
-                        k   v n           . f f       . v v   .               t   o o t r
-                        e   f g           .   .       . f f   .               a     . 3 t
-                        t                 v   v       v   v   v               2     v
-                                          e   e       e   e   e                     e
-                                          c   c       c   c   c                     c
-   ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
-   speed capabilities
-   link status                  X       X X                                   X X
-   link status event                    X X                                     X
-   queue status event                                                           X
-   Rx interrupt                         X X X X
-   queue start/stop             X   X   X X X X                               X
-   MTU update                   X   X
-   jumbo frame                  X   X   X X X X
-   scattered Rx                 X   X   X X X X                               X
-   LRO
-   TSO                          X   X   X X X X
-   promiscuous mode             X       X X X X                               X
-   allmulticast mode            X       X X X X                               X
-   unicast MAC filter                   X X X X
-   multicast MAC filter                 X X X X
-   RSS hash                     X   X   X X X X
-   RSS key update                   X   X X X X
-   RSS reta update                  X   X X X X
-   VMDq                                 X X
-   SR-IOV                           X   X X
-   DCB                                  X X
-   VLAN filter                          X X X X
-   ethertype filter                     X X
-   n-tuple filter
-   SYN filter
-   tunnel filter                        X X
-   flexible filter
-   hash filter                          X X X X
-   flow director                        X X
-   flow control                 X       X X
-   rate limitation
-   traffic mirroring                    X X
-   CRC offload                  X   X   X   X
-   VLAN offload                 X   X   X   X
-   QinQ offload                         X   X
-   L3 checksum offload          X   X   X   X
-   L4 checksum offload          X   X   X   X
-   inner L3 checksum                X   X   X
-   inner L4 checksum                X   X   X
-   packet type parsing          X       X   X
-   timesync                             X X
-   basic stats                  X   X   X X X X                               X X
-   extended stats                   X   X X X X
-   stats per queue              X                                             X
-   EEPROM dump
-   registers dump
-   multiprocess aware                   X X X X
-   BSD nic_uio                  X       X X X X
-   Linux UIO                    X   X   X X X X
-   Linux VFIO                   X       X X X X
-   other kdrv                                                                 X
-   ARMv7
-   ARMv8
-   Power8
-   TILE-Gx
-   x86-32                       X   X   X X X X                                 X
-   x86-64                       X   X   X X X X                               X X
-   usage doc                    X                                             X
-   design doc
-   perf doc
-   ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
+   ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
+   Feature              a b b b b c e e e i i i i i i i i i i f f f f m m m n n p q q r s t v v v v x
+                        f n n n o x 1 n n 4 4 4 4 g g x x x x m m m m l l p f u c e e i z h h i i m e
+                        p x x x n g 0 a i 0 0 0 0 b b g g g g 1 1 1 1 x x i p l a d d n e u o r r x n
+                        a 2 2 t d b 0   c e e e e   v b b b b 0 0 0 0 4 5 p   l p e e g d n s t t n v
+                        c x x   i e 0       . v v   f e e e e k k k k     e         v   a d t i i e i
+                        k   v   n           . f f       . v v   . v v               f   t e   o o t r
+                        e   f   g           .   .       . f f   . f f                   a r     . 3 t
+                        t                   v   v       v   v   v   v                   2 x     v
+                                            e   e       e   e   e   e                           e
+                                            c   c       c   c   c   c                           c
+   ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
+   Speed capabilities
+   Link status            Y Y Y   Y Y   Y Y Y     Y   Y Y Y Y         Y Y         Y Y   Y Y Y Y Y
+   Link status event      Y Y       Y     Y Y     Y   Y Y             Y Y         Y Y     Y Y
+   Queue status event                                                                       Y
+   Rx interrupt                     Y     Y Y Y Y Y Y Y Y Y Y Y Y Y Y
+   Queue start/stop           Y   Y   Y Y Y Y Y Y     Y Y     Y Y Y Y Y Y               Y Y   Y Y
+   MTU update                     Y Y Y           Y   Y Y Y Y         Y Y                 Y
+   Jumbo frame                    Y Y Y Y Y Y Y Y Y   Y Y Y Y Y Y Y Y Y Y       Y Y Y     Y
+   Scattered Rx                   Y Y Y   Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y               Y Y   Y
+   LRO                                                Y Y Y Y
+   TSO                            Y   Y   Y Y Y Y Y Y Y Y Y Y Y Y Y Y
+   Promiscuous mode       Y Y Y   Y Y   Y Y Y Y Y Y Y Y Y     Y Y     Y Y         Y Y   Y Y   Y Y
+   Allmulticast mode              Y Y     Y Y Y Y Y Y Y Y Y Y Y Y     Y Y         Y Y   Y Y   Y Y
+   Unicast MAC filter     Y Y Y     Y   Y Y Y Y Y Y Y Y Y Y Y Y Y     Y Y         Y Y         Y Y
+   Multicast MAC filter   Y Y Y         Y Y Y Y Y             Y Y     Y Y         Y Y         Y Y
+   RSS hash                       Y   Y Y Y Y Y Y Y   Y Y Y Y Y Y Y Y Y Y         Y Y     Y
+   RSS key update                     Y   Y Y Y Y Y   Y Y Y Y Y Y Y Y   Y                 Y
+   RSS reta update            Y       Y   Y Y Y Y Y   Y Y Y Y Y Y Y Y   Y                 Y
+   VMDq                                   Y Y     Y   Y Y     Y Y
+   SR-IOV                   Y         Y   Y Y     Y   Y Y             Y Y           Y     Y
+   DCB                                    Y Y     Y   Y Y
+   VLAN filter                      Y   Y Y Y Y Y Y Y Y Y Y Y Y Y     Y Y         Y Y         Y Y
+   Ethertype filter                       Y Y     Y   Y Y
+   N-tuple filter                                 Y   Y Y
+   SYN filter                                     Y   Y Y
+   Tunnel filter                          Y Y         Y Y
+   Flexible filter                                Y
+   Hash filter                            Y Y Y Y
+   Flow director                          Y Y         Y Y               Y
+   Flow control                   Y Y     Y Y     Y   Y Y                         Y Y
+   Rate limitation                                    Y Y
+   Traffic mirroring                      Y Y         Y Y
+   CRC offload                    Y Y Y Y Y   Y   Y Y Y   Y   Y Y Y Y   Y         Y Y     Y
+   VLAN offload                   Y Y Y Y Y   Y   Y Y Y   Y   Y Y Y Y   Y         Y Y     P
+   QinQ offload                     Y     Y   Y   Y Y Y   Y
+   L3 checksum offload            Y Y Y Y Y   Y   Y Y Y   Y   Y Y Y Y Y Y                 Y
+   L4 checksum offload            Y Y Y Y Y   Y   Y Y Y   Y   Y Y Y Y Y Y                 Y
+   Inner L3 checksum                  Y   Y   Y       Y   Y           Y
+   Inner L4 checksum                  Y   Y   Y       Y   Y           Y
+   Packet type parsing            Y     Y Y   Y   Y Y Y   Y   Y Y Y Y Y Y         Y Y     Y
+   Timesync                               Y Y     Y   Y Y
+   Basic stats            Y Y Y   Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y       Y Y Y   Y Y Y Y Y
+   Extended stats             Y       Y   Y Y Y Y Y Y Y Y Y Y Y Y Y Y                   Y   Y
+   Stats per queue                Y                   Y Y     Y Y Y Y Y Y         Y Y   Y Y   Y Y
+   EEPROM dump                    Y               Y   Y Y
+   Registers dump                 Y               Y Y Y Y Y Y                             Y
+   Multiprocess aware                     Y Y Y Y     Y Y Y Y Y Y Y Y Y Y       Y Y Y     Y
+   BSD nic_uio                    Y Y   Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y                         Y Y
+   Linux UIO              Y Y Y   Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y             Y Y         Y Y
+   Linux VFIO                     Y Y   Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y                     Y   Y Y
+   Other kdrv                                                         Y Y               Y
+   ARMv7                                                                        Y             Y Y
+   ARMv8                                              Y Y Y Y                   Y         Y   Y Y
+   Power8                                                             Y Y       Y
+   TILE-Gx                                                                      Y
+   x86-32                         Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y       Y           Y Y Y
+   x86-64                 Y Y Y   Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y       Y Y Y   Y   Y Y Y
+   Usage doc              Y Y     Y     Y                             Y Y       Y Y Y   Y Y   Y
+   Design doc
+   Perf doc
+   ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
+
+.. Note::
+
+   Features marked with "P" are partially supported. Refer to the appropriate
+   NIC guide in the following sections for details.