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