Documentation/scsi/bnx2fc.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 ===========================
   4 Operating FCoE using bnx2fc
   5 ===========================
   6 Broadcom FCoE offload through bnx2fc is full stateful hardware offload that
   7 cooperates with all interfaces provided by the Linux ecosystem for FC/FCoE and
   8 SCSI controllers.  As such, FCoE functionality, once enabled is largely
   9 transparent. Devices discovered on the SAN will be registered and unregistered
  10 automatically with the upper storage layers.
  11
  12 Despite the fact that the Broadcom's FCoE offload is fully offloaded, it does
  13 depend on the state of the network interfaces to operate. As such, the network
  14 interface (e.g. eth0) associated with the FCoE offload initiator must be 'up'.
  15 It is recommended that the network interfaces be configured to be brought up
  16 automatically at boot time.
  17
  18 Furthermore, the Broadcom FCoE offload solution creates VLAN interfaces to
  19 support the VLANs that have been discovered for FCoE operation (e.g.
  20 eth0.1001-fcoe).  Do not delete or disable these interfaces or FCoE operation
  21 will be disrupted.
  22
  23 Driver Usage Model:
  24 ===================
  25
  26 1. Ensure that fcoe-utils package is installed.
  27
  28 2. Configure the interfaces on which bnx2fc driver has to operate on.
  29 Here are the steps to configure:
  30
  31         a. cd /etc/fcoe
  32         b. copy cfg-ethx to cfg-eth5 if FCoE has to be enabled on eth5.
  33         c. Repeat this for all the interfaces where FCoE has to be enabled.
  34         d. Edit all the cfg-eth files to set "no" for DCB_REQUIRED** field, and
  35            "yes" for AUTO_VLAN.
  36         e. Other configuration parameters should be left as default
  37
  38 3. Ensure that "bnx2fc" is in SUPPORTED_DRIVERS list in /etc/fcoe/config.
  39
  40 4. Start fcoe service. (service fcoe start). If Broadcom devices are present in
  41 the system, bnx2fc driver would automatically claim the interfaces, starts vlan
  42 discovery and log into the targets.
  43
  44 5. "Symbolic Name" in 'fcoeadm -i' output would display if bnx2fc has claimed
  45 the interface.
  46
  47 Eg::
  48
  49  [root@bh2 ~]# fcoeadm -i
  50     Description:      NetXtreme II BCM57712 10 Gigabit Ethernet
  51     Revision:         01
  52     Manufacturer:     Broadcom Corporation
  53     Serial Number:    0010186FD558
  54     Driver:           bnx2x 1.70.00-0
  55     Number of Ports:  2
  56
  57         Symbolic Name:     bnx2fc v1.0.5 over eth5.4
  58         OS Device Name:    host11
  59         Node Name:         0x10000010186FD559
  60         Port Name:         0x20000010186FD559
  61         FabricName:        0x2001000DECB3B681
  62         Speed:             10 Gbit
  63         Supported Speed:   10 Gbit
  64         MaxFrameSize:      2048
  65         FC-ID (Port ID):   0x0F0377
  66         State:             Online
  67
  68 6. Verify the vlan discovery is performed by running ifconfig and notice
  69    <INTERFACE>.<VLAN>-fcoe interfaces are automatically created.
  70
  71 Refer to fcoeadm manpage for more information on fcoeadm operations to
  72 create/destroy interfaces or to display lun/target information.
  73
  74 NOTE
  75 ====
  76 ** Broadcom FCoE capable devices implement a DCBX/LLDP client on-chip. Only one
  77 LLDP client is allowed per interface. For proper operation all host software
  78 based DCBX/LLDP clients (e.g. lldpad) must be disabled. To disable lldpad on a
  79 given interface, run the following command::
  80
  81         lldptool set-lldp -i <interface_name> adminStatus=disabled