doc: update bnxt guide
authorAjit Khaparde <ajit.khaparde@broadcom.com>
Thu, 29 Sep 2016 17:04:08 +0000 (12:04 -0500)
committerBruce Richardson <bruce.richardson@intel.com>
Thu, 13 Oct 2016 13:30:59 +0000 (15:30 +0200)
This patch reformats the Broadcom PMD driver documentation.

Also since the PMD now loads on a VF interface, update the
documentation accordingly.

Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
doc/guides/nics/bnxt.rst

index cf7fca8..ad33cd5 100644 (file)
     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-bnxt poll mode driver library
-=============================
+BNXT Poll Mode Driver
+=====================
 
 The bnxt poll mode library (**librte_pmd_bnxt**) implements support for:
-**Broadcom NetXtreme-C®/NetXtreme-E® BCM5730X and BCM5740X family of
-Ethernet Network Controllers**.  These adapters support Standards compliant
-10/25/50Gbps 30MPPS full-duplex throughput.
-**Broadcom StrataGX® BCM5871X Series of Communucations Processors**
-These ARM based processors target a broad range of networking applications
-including virtual CPE (vCPE) and NFV appliances, 10G service routers and
-gateways, control plane processing for Ethernet switches and network attached
-storage (NAS).
-
-Information about the NetXtreme family of adapters can be found in the
-`NetXtreme® Brand section <https://www.broadcom.com/products/ethernet-communication-and-switching?technology%5B%5D=88>`_
-of the `Broadcom website <http://www.broadcom.com/>`_.
-
-Information about the StrataGX family of adapters can be found in the
-`StrataGX® BCM5871X Series section
-<http://www.broadcom.com/products/enterprise-and-network-processors/processors/bcm58712>`_
-of the `Broadcom website <http://www.broadcom.com/>`_.
+
+  * **Broadcom NetXtreme-C®/NetXtreme-E® BCM5730X and BCM5740X family of
+    Ethernet Network Controllers**
+
+    These adapters support Standards compliant 10/25/50Gbps 30MPPS
+    full-duplex throughput.
+
+    Information about the NetXtreme family of adapters can be found in the
+    `NetXtreme® Brand section
+    <https://www.broadcom.com/products/ethernet-communication-and-switching?technology%5B%5D=88>`_
+    of the `Broadcom website <http://www.broadcom.com/>`_.
+
+  * **Broadcom StrataGX® BCM5871X Series of Communucations Processors**
+
+    These ARM based processors target a broad range of networking applications
+    including virtual CPE (vCPE) and NFV appliances, 10G service routers and
+    gateways, control plane processing for Ethernet switches and network
+    attached storage (NAS).
+
+    Information about the StrataGX family of adapters can be found in the
+    `StrataGX® BCM5871X Series section
+    <http://www.broadcom.com/products/enterprise-and-network-processors/processors/bcm58712>`_
+    of the `Broadcom website <http://www.broadcom.com/>`_.
 
 Limitations
 -----------
@@ -56,5 +62,3 @@ With the current driver, allocated mbufs must be large enough to hold
 the entire received frame.  If the mbufs are not large enough, the
 packets will be dropped.  This is most limiting when jumbo frames are
 used.
-
-SR-IOV is not supported.