doc: update bnxt guide
[dpdk.git] / doc / guides / nics / bnxt.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright 2016-2019 Broadcom
3
4 BNXT Poll Mode Driver
5 =====================
6
7 The BNXT PMD (**librte_pmd_bnxt**) implements support for adapters based on
8 Ethernet controllers and SoCs belonging to the **Broadcom BCM5730X NetXtreme-C®
9 Family of Ethernet Network Controllers**, the **Broadcom BCM574XX/BCM575XX
10 NetXtreme-E® Family of Ethernet Network Controllers**, the **Broadcom BCM588XX
11 Stingray Family of SmartNIC Adapters**, and the **Broadcom StrataGX® BCM5871X
12 Series of Communications Processors**.  A complete list with links to reference
13 material is included below.
14
15
16 BNXT PMD Features
17 -----------------
18
19 The BNXT PMD includes support for the following features:
20
21    * Multiple transmit and receive queues
22    * Queue start/stop
23    * RSS hash
24    * RSS key configuration
25    * RSS reta configuration
26    * VMDq
27    * Packet type parsing
28    * Configurable RX CRC stripping
29    * L3/L4 checksum offload
30    * LRO offload
31    * TSO offload
32    * VLAN offload
33    * SR-IOV VF
34    * Basic and extended port statistics
35    * Link state reporting
36    * Flow control
37    * Ethertype filtering
38    * N-tuple filtering
39    * Promiscuous mode
40    * Unicast and multicast MAC filtering
41    * Scatter/gather transmit and receive
42    * Jumbo frames
43    * Vector PMD
44
45 BNXT Vector PMD
46 ---------------
47
48 The BNXT PMD includes support for SSE vector mode on x86 platforms. Vector
49 provides significantly improved performance over the base implementation,
50 however it does not support all of the features that are supported by the
51 base (non-vector) implementation. Vector mode will be selected and enabled
52 automatically when the port is started if allowed by the current configuration.
53
54 RX Requirements for Vector Mode
55 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
56
57 Vector mode receive will be enabled if the following constrainsts are met:
58    * Packets must fit within a single mbuf (no scatter RX).
59    * LRO offload must be disabled.
60
61 TX Requirements for Vector Mode
62 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
63
64 Vector mode transmit will be enabled if the following constrainsts are met:
65    * Packets must be contained within a single mbuf (no gather TX).
66    * All transmit offloads other than VLAN insertion must be disabled.
67
68 BNXT PMD Supported Chipsets and Adapters
69 ----------------------------------------
70
71 Chipsets and adapters supported by the bnxt PMD include:
72
73   * **Broadcom BCM5730X NetXtreme-C® Family of Ethernet Network Controllers**
74
75        * M150c - Single-port 40/50 Gigabit Ethernet Adapter
76        * P150c - Single-port 40/50 Gigabit Ethernet Adapter
77        * P225c - Dual-port 10/25 Gigabit Ethernet Adapter
78
79   * **Broadcom BCM574XX/BCM575XX NetXtreme-E® Family of Ethernet Network Controllers**
80
81        * M125P - Single-port OCP 2.0 10/25 Gigabit Ethernet Adapter
82        * M150P - Single-port OCP 2.0 50 Gigabit Ethernet Adapter
83        * M150PM - Single-port OCP 2.0 Multi-Host 50 Gigabit Ethernet Adapter
84        * M210P - Dual-port OCP 2.0 10 Gigabit Ethernet Adapter
85        * M210TP - Dual-port OCP 2.0 10 Gigabit Ethernet Adapter
86        * M11000G - Single-port OCP 2.0 10/25/50/100 Gigabit Ethernet Adapter
87        * N150G - Single-port OCP 3.0 50 Gigabit Ethernet Adapter
88        * M225P - Dual-port OCP 2.0 10/25 Gigabit Ethernet Adapter
89        * N210P - Dual-port OCP 3.0 10 Gigabit Ethernet Adapter
90        * N210TP - Dual-port OCP 3.0 10 Gigabit Ethernet Adapter
91        * N225P - Dual-port OCP 3.0 10/25 Gigabit Ethernet Adapter
92        * N250G - Dual-port OCP 3.0 50 Gigabit Ethernet Adapter
93        * N410SG - Quad-port OCP 3.0 10 Gigabit Ethernet Adapter
94        * N410SGBT - Quad-port OCP 3.0 10 Gigabit Ethernet Adapter
95        * N425G - Quad-port OCP 3.0 10/25 Gigabit Ethernet Adapter
96        * N1100G - Single-port OCP 3.0 10/25/50/100 Gigabit Ethernet Adapter
97        * N2100G - Dual-port OCP 3.0 10/25/50/100 Gigabit Ethernet Adapter
98        * N2200G - Dual-port OCP 3.0 10/25/50/100/200 Gigabit Ethernet Adapter
99        * P150P - Single-port 50 Gigabit Ethernet Adapter
100        * P210P - Dual-port 10 Gigabit Ethernet Adapter
101        * P210TP - Dual-port 10 Gigabit Ethernet Adapter
102        * P225P - Dual-port 10/25 Gigabit Ethernet Adapter
103        * P410SG - Quad-port 10 Gigabit Ethernet Adapter
104        * P410SGBT - Quad-port 10 Gigabit Ethernet Adapter
105        * P425G - Quad-port 10/25 Gigabit Ethernet Adapter
106        * P1100G - Single-port 10/25/50/100 Gigabit Ethernet Adapter
107        * P2100G - Dual-port 10/25/50/100 Gigabit Ethernet Adapter
108        * P2200G - Dual-port 10/25/50/100/200 Gigabit Ethernet Adapter
109
110     Information about Ethernet adapters in the NetXtreme family of
111     adapters can be found in the `NetXtreme® Brand section
112     <https://www.broadcom.com/products/ethernet-connectivity/network-adapters/>`_
113     of the `Broadcom website <http://www.broadcom.com/>`_.
114
115   * **Broadcom BCM588XX Stingray Family of SmartNIC Adapters**
116
117        * PS410T - Quad-port 10 Gigabit Ethernet SmartNIC
118        * PS225 - Dual-port 25 Gigabit Ethernet SmartNIC
119        * PS250 - Dual-Port 50 Gigabit Ethernet SmartNIC
120
121     Information about the Stingray family of SmartNIC adapters can be found in the
122     `Stingray® Brand section
123     <https://www.broadcom.com/products/ethernet-connectivity/smartnic/>`_
124     of the `Broadcom website <http://www.broadcom.com/>`_.
125
126   * **Broadcom StrataGX® BCM5871X Series of Communucations Processors**
127
128     These ARM based processors target a broad range of networking applications
129     including virtual CPE (vCPE) and NFV appliances, 10G service routers and
130     gateways, control plane processing for Ethernet switches and network
131     attached storage (NAS).
132
133     Information about the StrataGX family of adapters can be found in the
134     `StrataGX® BCM58712
135     <http://www.broadcom.com/products/embedded-and-networking-processors/communications/bcm58712>`_
136     and `StrataGX® BCM58713
137     <http://www.broadcom.com/products/embedded-and-networking-processors/communications/bcm58713>`_
138     sections of the `Broadcom website <http://www.broadcom.com/>`_.