^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) What: /sys/bus/fcoe/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) Date: August 2012
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) KernelVersion: TBD
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) Contact: Robert Love <robert.w.love@intel.com>, devel@open-fcoe.org
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) Description: The FCoE bus. Attributes in this directory are control interfaces.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) Attributes:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) ctlr_create:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) 'FCoE Controller' instance creation interface. Writing an
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) <ifname> to this file will allocate and populate sysfs with a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) fcoe_ctlr_device (ctlr_X). The user can then configure any
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) per-port settings and finally write to the fcoe_ctlr_device's
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) 'start' attribute to begin the kernel's discovery and login
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) process.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) ctlr_destroy:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) 'FCoE Controller' instance removal interface. Writing a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) fcoe_ctlr_device's sysfs name to this file will log the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) fcoe_ctlr_device out of the fabric or otherwise connected
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) FCoE devices. It will also free all kernel memory allocated
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) for this fcoe_ctlr_device and any structures associated
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) with it, this includes the scsi_host.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) What: /sys/bus/fcoe/devices/ctlr_X
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) Date: March 2012
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) KernelVersion: TBD
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) Contact: Robert Love <robert.w.love@intel.com>, devel@open-fcoe.org
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) Description: 'FCoE Controller' instances on the fcoe bus.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) The FCoE Controller now has a three stage creation process.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) 1) Write interface name to ctlr_create 2) Configure the FCoE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) Controller (ctlr_X) 3) Enable the FCoE Controller to begin
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) discovery and login. The FCoE Controller is destroyed by
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) writing it's name, i.e. ctlr_X to the ctlr_delete file.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) Attributes:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) fcf_dev_loss_tmo:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) Device loss timeout period (see below). Changing
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) this value will change the dev_loss_tmo for all
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) FCFs discovered by this controller.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) mode:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) Display or change the FCoE Controller's mode. Possible
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) modes are 'Fabric' and 'VN2VN'. If a FCoE Controller
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) is started in 'Fabric' mode then FIP FCF discovery is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) initiated and ultimately a fabric login is attempted.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) If a FCoE Controller is started in 'VN2VN' mode then
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) FIP VN2VN discovery and login is performed. A FCoE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) Controller only supports one mode at a time.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) enabled:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) Whether an FCoE controller is enabled or disabled.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) 0 if disabled, 1 if enabled. Writing either 0 or 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) to this file will enable or disable the FCoE controller.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) lesb/link_fail:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) Link Error Status Block (LESB) link failure count.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) lesb/vlink_fail:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) Link Error Status Block (LESB) virtual link
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) failure count.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) lesb/miss_fka:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) Link Error Status Block (LESB) missed FCoE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) Initialization Protocol (FIP) Keep-Alives (FKA).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) lesb/symb_err:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) Link Error Status Block (LESB) symbolic error count.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) lesb/err_block:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) Link Error Status Block (LESB) block error count.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) lesb/fcs_error:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) Link Error Status Block (LESB) Fibre Channel
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) Services error count.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) Notes: ctlr_X (global increment starting at 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) What: /sys/bus/fcoe/devices/fcf_X
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) Date: March 2012
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) KernelVersion: TBD
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) Contact: Robert Love <robert.w.love@intel.com>, devel@open-fcoe.org
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) Description: 'FCoE FCF' instances on the fcoe bus. A FCF is a Fibre Channel
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) Forwarder, which is a FCoE switch that can accept FCoE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) (Ethernet) packets, unpack them, and forward the embedded
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) Fibre Channel frames into a FC fabric. It can also take
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) outbound FC frames and pack them in Ethernet packets to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) be sent to their destination on the Ethernet segment.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) Attributes:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) fabric_name:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) Identifies the fabric that the FCF services.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) switch_name:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) Identifies the FCF.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) priority:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) The switch's priority amongst other FCFs on the same
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) fabric.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) selected:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) 1 indicates that the switch has been selected for use;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) 0 indicates that the switch will not be used.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) fc_map:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) The Fibre Channel MAP
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) vfid:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) The Virtual Fabric ID
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) mac:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) The FCF's MAC address
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) fka_period:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) The FIP Keep-Alive period
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) fabric_state: The internal kernel state
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) - "Unknown" - Initialization value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) - "Disconnected" - No link to the FCF/fabric
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) - "Connected" - Host is connected to the FCF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) - "Deleted" - FCF is being removed from the system
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) dev_loss_tmo: The device loss timeout period for this FCF.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) Notes: A device loss infrastructure similar to the FC Transport's
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) is present in fcoe_sysfs. It is nice to have so that a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) link flapping adapter doesn't continually advance the count
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) used to identify the discovered FCF. FCFs will exist in a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) "Disconnected" state until either the timer expires and the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) FCF becomes "Deleted" or the FCF is rediscovered and becomes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) "Connected."
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) Users: The first user of this interface will be the fcoeadm application,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) which is commonly packaged in the fcoe-utils package.