1What:		/sys/bus/fcoe/ctlr_X
2Date:		March 2012
3KernelVersion:	TBD
4Contact:	Robert Love <robert.w.love@intel.com>, devel@open-fcoe.org
5Description:	'FCoE Controller' instances on the fcoe bus
6Attributes:
7
8	fcf_dev_loss_tmo: Device loss timeout peroid (see below). Changing
9			  this value will change the dev_loss_tmo for all
10			  FCFs discovered by this controller.
11
12	lesb_link_fail:   Link Error Status Block (LESB) link failure count.
13
14	lesb_vlink_fail:  Link Error Status Block (LESB) virtual link
15			  failure count.
16
17	lesb_miss_fka:    Link Error Status Block (LESB) missed FCoE
18			  Initialization Protocol (FIP) Keep-Alives (FKA).
19
20	lesb_symb_err:    Link Error Status Block (LESB) symbolic error count.
21
22	lesb_err_block:   Link Error Status Block (LESB) block error count.
23
24	lesb_fcs_error:   Link Error Status Block (LESB) Fibre Channel
25			  Serivces error count.
26
27Notes: ctlr_X (global increment starting at 0)
28
29What:		/sys/bus/fcoe/fcf_X
30Date:		March 2012
31KernelVersion:	TBD
32Contact:	Robert Love <robert.w.love@intel.com>, devel@open-fcoe.org
33Description:	'FCoE FCF' instances on the fcoe bus. A FCF is a Fibre Channel
34		Forwarder, which is a FCoE switch that can accept FCoE
35		(Ethernet) packets, unpack them, and forward the embedded
36		Fibre Channel frames into a FC fabric. It can also take
37		outbound FC frames and pack them in Ethernet packets to
38		be sent to their destination on the Ethernet segment.
39Attributes:
40
41	fabric_name: Identifies the fabric that the FCF services.
42
43	switch_name: Identifies the FCF.
44
45	priority:    The switch's priority amongst other FCFs on the same
46		     fabric.
47
48	selected:    1 indicates that the switch has been selected for use;
49		     0 indicates that the swich will not be used.
50
51	fc_map:      The Fibre Channel MAP
52
53	vfid:	     The Virtual Fabric ID
54
55	mac:         The FCF's MAC address
56
57	fka_peroid:  The FIP Keep-Alive peroid
58
59	fabric_state: The internal kernel state
60		      "Unknown" - Initialization value
61		      "Disconnected" - No link to the FCF/fabric
62		      "Connected" - Host is connected to the FCF
63		      "Deleted" - FCF is being removed from the system
64
65	dev_loss_tmo: The device loss timeout peroid for this FCF.
66
67Notes: A device loss infrastructre similar to the FC Transport's
68       is present in fcoe_sysfs. It is nice to have so that a
69       link flapping adapter doesn't continually advance the count
70       used to identify the discovered FCF. FCFs will exist in a
71       "Disconnected" state until either the timer expires and the
72       FCF becomes "Deleted" or the FCF is rediscovered and becomes
73       "Connected."
74
75
76Users: The first user of this interface will be the fcoeadm application,
77       which is commonly packaged in the fcoe-utils package.
78