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