From 1d4f8dfe2d976d49e6d9065643f106b1750f3445 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Mon, 2 Mar 2020 09:15:43 +0100 Subject: scsi: docs: convert bnx2fc.txt to ReST Link: https://lore.kernel.org/r/f239116bd2c36f6fc8deb62e325bb8161da04270.1583136624.git.mchehab+huawei@kernel.org Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Martin K. Petersen --- Documentation/scsi/bnx2fc.rst | 81 +++++++++++++++++++++++++++++++++++++++++++ Documentation/scsi/bnx2fc.txt | 75 --------------------------------------- Documentation/scsi/index.rst | 1 + 3 files changed, 82 insertions(+), 75 deletions(-) create mode 100644 Documentation/scsi/bnx2fc.rst delete mode 100644 Documentation/scsi/bnx2fc.txt (limited to 'Documentation/scsi') diff --git a/Documentation/scsi/bnx2fc.rst b/Documentation/scsi/bnx2fc.rst new file mode 100644 index 000000000000..2fef2dff80c7 --- /dev/null +++ b/Documentation/scsi/bnx2fc.rst @@ -0,0 +1,81 @@ +.. SPDX-License-Identifier: GPL-2.0 + +=========================== +Operating FCoE using bnx2fc +=========================== +Broadcom FCoE offload through bnx2fc is full stateful hardware offload that +cooperates with all interfaces provided by the Linux ecosystem for FC/FCoE and +SCSI controllers. As such, FCoE functionality, once enabled is largely +transparent. Devices discovered on the SAN will be registered and unregistered +automatically with the upper storage layers. + +Despite the fact that the Broadcom's FCoE offload is fully offloaded, it does +depend on the state of the network interfaces to operate. As such, the network +interface (e.g. eth0) associated with the FCoE offload initiator must be 'up'. +It is recommended that the network interfaces be configured to be brought up +automatically at boot time. + +Furthermore, the Broadcom FCoE offload solution creates VLAN interfaces to +support the VLANs that have been discovered for FCoE operation (e.g. +eth0.1001-fcoe). Do not delete or disable these interfaces or FCoE operation +will be disrupted. + +Driver Usage Model: +=================== + +1. Ensure that fcoe-utils package is installed. + +2. Configure the interfaces on which bnx2fc driver has to operate on. +Here are the steps to configure: + + a. cd /etc/fcoe + b. copy cfg-ethx to cfg-eth5 if FCoE has to be enabled on eth5. + c. Repeat this for all the interfaces where FCoE has to be enabled. + d. Edit all the cfg-eth files to set "no" for DCB_REQUIRED** field, and + "yes" for AUTO_VLAN. + e. Other configuration parameters should be left as default + +3. Ensure that "bnx2fc" is in SUPPORTED_DRIVERS list in /etc/fcoe/config. + +4. Start fcoe service. (service fcoe start). If Broadcom devices are present in +the system, bnx2fc driver would automatically claim the interfaces, starts vlan +discovery and log into the targets. + +5. "Symbolic Name" in 'fcoeadm -i' output would display if bnx2fc has claimed +the interface. + +Eg:: + + [root@bh2 ~]# fcoeadm -i + Description: NetXtreme II BCM57712 10 Gigabit Ethernet + Revision: 01 + Manufacturer: Broadcom Corporation + Serial Number: 0010186FD558 + Driver: bnx2x 1.70.00-0 + Number of Ports: 2 + + Symbolic Name: bnx2fc v1.0.5 over eth5.4 + OS Device Name: host11 + Node Name: 0x10000010186FD559 + Port Name: 0x20000010186FD559 + FabricName: 0x2001000DECB3B681 + Speed: 10 Gbit + Supported Speed: 10 Gbit + MaxFrameSize: 2048 + FC-ID (Port ID): 0x0F0377 + State: Online + +6. Verify the vlan discovery is performed by running ifconfig and notice + .-fcoe interfaces are automatically created. + +Refer to fcoeadm manpage for more information on fcoeadm operations to +create/destroy interfaces or to display lun/target information. + +NOTE +==== +** Broadcom FCoE capable devices implement a DCBX/LLDP client on-chip. Only one +LLDP client is allowed per interface. For proper operation all host software +based DCBX/LLDP clients (e.g. lldpad) must be disabled. To disable lldpad on a +given interface, run the following command:: + + lldptool set-lldp -i adminStatus=disabled diff --git a/Documentation/scsi/bnx2fc.txt b/Documentation/scsi/bnx2fc.txt deleted file mode 100644 index 80823556d62f..000000000000 --- a/Documentation/scsi/bnx2fc.txt +++ /dev/null @@ -1,75 +0,0 @@ -Operating FCoE using bnx2fc -=========================== -Broadcom FCoE offload through bnx2fc is full stateful hardware offload that -cooperates with all interfaces provided by the Linux ecosystem for FC/FCoE and -SCSI controllers. As such, FCoE functionality, once enabled is largely -transparent. Devices discovered on the SAN will be registered and unregistered -automatically with the upper storage layers. - -Despite the fact that the Broadcom's FCoE offload is fully offloaded, it does -depend on the state of the network interfaces to operate. As such, the network -interface (e.g. eth0) associated with the FCoE offload initiator must be 'up'. -It is recommended that the network interfaces be configured to be brought up -automatically at boot time. - -Furthermore, the Broadcom FCoE offload solution creates VLAN interfaces to -support the VLANs that have been discovered for FCoE operation (e.g. -eth0.1001-fcoe). Do not delete or disable these interfaces or FCoE operation -will be disrupted. - -Driver Usage Model: -=================== - -1. Ensure that fcoe-utils package is installed. - -2. Configure the interfaces on which bnx2fc driver has to operate on. -Here are the steps to configure: - a. cd /etc/fcoe - b. copy cfg-ethx to cfg-eth5 if FCoE has to be enabled on eth5. - c. Repeat this for all the interfaces where FCoE has to be enabled. - d. Edit all the cfg-eth files to set "no" for DCB_REQUIRED** field, and - "yes" for AUTO_VLAN. - e. Other configuration parameters should be left as default - -3. Ensure that "bnx2fc" is in SUPPORTED_DRIVERS list in /etc/fcoe/config. - -4. Start fcoe service. (service fcoe start). If Broadcom devices are present in -the system, bnx2fc driver would automatically claim the interfaces, starts vlan -discovery and log into the targets. - -5. "Symbolic Name" in 'fcoeadm -i' output would display if bnx2fc has claimed -the interface. -Eg: -[root@bh2 ~]# fcoeadm -i - Description: NetXtreme II BCM57712 10 Gigabit Ethernet - Revision: 01 - Manufacturer: Broadcom Corporation - Serial Number: 0010186FD558 - Driver: bnx2x 1.70.00-0 - Number of Ports: 2 - - Symbolic Name: bnx2fc v1.0.5 over eth5.4 - OS Device Name: host11 - Node Name: 0x10000010186FD559 - Port Name: 0x20000010186FD559 - FabricName: 0x2001000DECB3B681 - Speed: 10 Gbit - Supported Speed: 10 Gbit - MaxFrameSize: 2048 - FC-ID (Port ID): 0x0F0377 - State: Online - -6. Verify the vlan discovery is performed by running ifconfig and notice -.-fcoe interfaces are automatically created. - -Refer to fcoeadm manpage for more information on fcoeadm operations to -create/destroy interfaces or to display lun/target information. - -NOTE: -==== -** Broadcom FCoE capable devices implement a DCBX/LLDP client on-chip. Only one -LLDP client is allowed per interface. For proper operation all host software -based DCBX/LLDP clients (e.g. lldpad) must be disabled. To disable lldpad on a -given interface, run the following command: - -lldptool set-lldp -i adminStatus=disabled diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst index 1e37227f3536..d453fb3f1f7d 100644 --- a/Documentation/scsi/index.rst +++ b/Documentation/scsi/index.rst @@ -14,5 +14,6 @@ Linux SCSI Subsystem aic79xx aic7xxx bfa + bnx2fc scsi_transport_srp/figures -- cgit v1.2.3