nics/bnxt.rst

   1 ..  BSD LICENSE
   2     Copyright 2016 Broadcom Limited
   3
   4     Redistribution and use in source and binary forms, with or without
   5     modification, are permitted provided that the following conditions
   6     are met:
   7
   8     * Redistributions of source code must retain the above copyright
   9     notice, this list of conditions and the following disclaimer.
  10     * Redistributions in binary form must reproduce the above copyright
  11     notice, this list of conditions and the following disclaimer in
  12     the documentation and/or other materials provided with the
  13     distribution.
  14     * Neither the name of Broadcom Limited nor the names of its
  15     contributors may be used to endorse or promote products derived
  16     from this software without specific prior written permission.
  17
  18     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30 BNXT Poll Mode Driver
  31 =====================
  32
  33 The bnxt poll mode library (**librte_pmd_bnxt**) implements support for:
  34
  35   * **Broadcom NetXtreme-C®/NetXtreme-E® BCM5730X and BCM574XX family of
  36     Ethernet Network Controllers**
  37
  38     These adapters support Standards compliant 10/25/50/100Gbps 30MPPS
  39     full-duplex throughput.
  40
  41     Information about the NetXtreme family of adapters can be found in the
  42     `NetXtreme® Brand section
  43     <https://www.broadcom.com/products/ethernet-communication-and-switching?technology%5B%5D=88>`_
  44     of the `Broadcom website <http://www.broadcom.com/>`_.
  45
  46   * **Broadcom StrataGX® BCM5871X Series of Communucations Processors**
  47
  48     These ARM based processors target a broad range of networking applications
  49     including virtual CPE (vCPE) and NFV appliances, 10G service routers and
  50     gateways, control plane processing for Ethernet switches and network
  51     attached storage (NAS).
  52
  53     Information about the StrataGX family of adapters can be found in the
  54     `StrataGX® BCM5871X Series section
  55     <http://www.broadcom.com/products/enterprise-and-network-processors/processors/bcm58712>`_
  56     of the `Broadcom website <http://www.broadcom.com/>`_.
  57
  58 Limitations
  59 -----------
  60
  61 With the current driver, allocated mbufs must be large enough to hold
  62 the entire received frame.  If the mbufs are not large enough, the
  63 packets will be dropped.  This is most limiting when jumbo frames are
  64 used.