From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <stephen.hurd@broadcom.com>
Received: from mail-irv-18.broadcom.com (5520-maca-inet1-outside.broadcom.com
 [216.31.211.11]) by dpdk.org (Postfix) with ESMTP id 0760B2BE1
 for <dev@dpdk.org>; Fri,  4 Mar 2016 22:05:38 +0100 (CET)
Received: from mail-irva-13.broadcom.com (mail-irva-13.broadcom.com
 [10.11.16.103])
 by mail-irv-18.broadcom.com (Postfix) with ESMTP id BD9A4820E9;
 Fri,  4 Mar 2016 13:05:36 -0800 (PST)
Received: from DPDK-C1.broadcom.com (lab-irv-114-42 [10.13.114.42])
 by mail-irva-13.broadcom.com (Postfix) with ESMTP id 8074340FE8;
 Fri,  4 Mar 2016 13:05:19 -0800 (PST)
From: Stephen Hurd <stephen.hurd@broadcom.com>
To: dev@dpdk.org
Date: Fri,  4 Mar 2016 13:05:28 -0800
Message-Id: <1457125528-128877-8-git-send-email-stephen.hurd@broadcom.com>
X-Mailer: git-send-email 1.9.1
In-Reply-To: <1457125528-128877-1-git-send-email-stephen.hurd@broadcom.com>
References: <1457125528-128877-1-git-send-email-stephen.hurd@broadcom.com>
In-Reply-To: <1456978137-98097-1-git-send-email-stephen.hurd@broadcom.com>
References: <1456978137-98097-1-git-send-email-stephen.hurd@broadcom.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Subject: [dpdk-dev] [PATCH v3 7/7] doc: add guide for new bnxt driver
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Fri, 04 Mar 2016 21:05:38 -0000

Initial guide for bnxt driver, documents current limitations and
provides information link.

Signed-off-by: Stephen Hurd <stephen.hurd@broadcom.com>
---
 doc/guides/nics/bnxt.rst | 49 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 doc/guides/nics/bnxt.rst

diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst
new file mode 100644
index 0000000..fdfa3a6
--- /dev/null
+++ b/doc/guides/nics/bnxt.rst
@@ -0,0 +1,49 @@
+..  BSD LICENSE
+    Copyright 2016 Broadcom Limited
+
+    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 Broadcom Limited 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.
+
+bnxt poll mode driver library
+=============================
+
+The bnxt poll mode library (**librte_pmd_bnxt**) implements support for
+**Broadcom NetXtreme® C-Series**.  These adapters support Standards-
+compliant 10/25/50Gbps 30MPPS full-duplex throughput.
+
+Information about this 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 web site <http://www.broadcom.com/>`_.
+
+Limitations
+-----------
+
+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.
-- 
1.9.1