0001 What: /sys/bus/fcoe/
0002 Date: August 2012
0003 KernelVersion: TBD
0004 Contact: Robert Love <robert.w.love@intel.com>, devel@open-fcoe.org
0005 Description: The FCoE bus. Attributes in this directory are control interfaces.
0006
0007 Attributes:
0008
0009 ctlr_create:
0010 'FCoE Controller' instance creation interface. Writing an
0011 <ifname> to this file will allocate and populate sysfs with a
0012 fcoe_ctlr_device (ctlr_X). The user can then configure any
0013 per-port settings and finally write to the fcoe_ctlr_device's
0014 'start' attribute to begin the kernel's discovery and login
0015 process.
0016
0017 ctlr_destroy:
0018 'FCoE Controller' instance removal interface. Writing a
0019 fcoe_ctlr_device's sysfs name to this file will log the
0020 fcoe_ctlr_device out of the fabric or otherwise connected
0021 FCoE devices. It will also free all kernel memory allocated
0022 for this fcoe_ctlr_device and any structures associated
0023 with it, this includes the scsi_host.
0024
0025 What: /sys/bus/fcoe/devices/ctlr_X
0026 Date: March 2012
0027 KernelVersion: TBD
0028 Contact: Robert Love <robert.w.love@intel.com>, devel@open-fcoe.org
0029 Description: 'FCoE Controller' instances on the fcoe bus.
0030 The FCoE Controller now has a three stage creation process.
0031 1) Write interface name to ctlr_create 2) Configure the FCoE
0032 Controller (ctlr_X) 3) Enable the FCoE Controller to begin
0033 discovery and login. The FCoE Controller is destroyed by
0034 writing it's name, i.e. ctlr_X to the ctlr_delete file.
0035
0036 Attributes:
0037
0038 fcf_dev_loss_tmo:
0039 Device loss timeout period (see below). Changing
0040 this value will change the dev_loss_tmo for all
0041 FCFs discovered by this controller.
0042
0043 mode:
0044 Display or change the FCoE Controller's mode. Possible
0045 modes are 'Fabric' and 'VN2VN'. If a FCoE Controller
0046 is started in 'Fabric' mode then FIP FCF discovery is
0047 initiated and ultimately a fabric login is attempted.
0048 If a FCoE Controller is started in 'VN2VN' mode then
0049 FIP VN2VN discovery and login is performed. A FCoE
0050 Controller only supports one mode at a time.
0051
0052 enabled:
0053 Whether an FCoE controller is enabled or disabled.
0054 0 if disabled, 1 if enabled. Writing either 0 or 1
0055 to this file will enable or disable the FCoE controller.
0056
0057 lesb/link_fail:
0058 Link Error Status Block (LESB) link failure count.
0059
0060 lesb/vlink_fail:
0061 Link Error Status Block (LESB) virtual link
0062 failure count.
0063
0064 lesb/miss_fka:
0065 Link Error Status Block (LESB) missed FCoE
0066 Initialization Protocol (FIP) Keep-Alives (FKA).
0067
0068 lesb/symb_err:
0069 Link Error Status Block (LESB) symbolic error count.
0070
0071 lesb/err_block:
0072 Link Error Status Block (LESB) block error count.
0073
0074 lesb/fcs_error:
0075 Link Error Status Block (LESB) Fibre Channel
0076 Services error count.
0077
0078 Notes: ctlr_X (global increment starting at 0)
0079
0080 What: /sys/bus/fcoe/devices/fcf_X
0081 Date: March 2012
0082 KernelVersion: TBD
0083 Contact: Robert Love <robert.w.love@intel.com>, devel@open-fcoe.org
0084 Description: 'FCoE FCF' instances on the fcoe bus. A FCF is a Fibre Channel
0085 Forwarder, which is a FCoE switch that can accept FCoE
0086 (Ethernet) packets, unpack them, and forward the embedded
0087 Fibre Channel frames into a FC fabric. It can also take
0088 outbound FC frames and pack them in Ethernet packets to
0089 be sent to their destination on the Ethernet segment.
0090
0091 Attributes:
0092
0093 fabric_name:
0094 Identifies the fabric that the FCF services.
0095
0096 switch_name:
0097 Identifies the FCF.
0098
0099 priority:
0100 The switch's priority amongst other FCFs on the same
0101 fabric.
0102
0103 selected:
0104 1 indicates that the switch has been selected for use;
0105 0 indicates that the switch will not be used.
0106
0107 fc_map:
0108 The Fibre Channel MAP
0109
0110 vfid:
0111 The Virtual Fabric ID
0112
0113 mac:
0114 The FCF's MAC address
0115
0116 fka_period:
0117 The FIP Keep-Alive period
0118
0119 fabric_state: The internal kernel state
0120
0121 - "Unknown" - Initialization value
0122 - "Disconnected" - No link to the FCF/fabric
0123 - "Connected" - Host is connected to the FCF
0124 - "Deleted" - FCF is being removed from the system
0125
0126 dev_loss_tmo: The device loss timeout period for this FCF.
0127
0128 Notes: A device loss infrastructure similar to the FC Transport's
0129 is present in fcoe_sysfs. It is nice to have so that a
0130 link flapping adapter doesn't continually advance the count
0131 used to identify the discovered FCF. FCFs will exist in a
0132 "Disconnected" state until either the timer expires and the
0133 FCF becomes "Deleted" or the FCF is rediscovered and becomes
0134 "Connected."
0135
0136
0137 Users: The first user of this interface will be the fcoeadm application,
0138 which is commonly packaged in the fcoe-utils package.
