hc
2024-10-12 a5969cabbb4660eab42b6ef0412cbbd1200cf14d
kernel/Documentation/ABI/testing/sysfs-bus-fcoe
....@@ -3,16 +3,19 @@
33 KernelVersion: TBD
44 Contact: Robert Love <robert.w.love@intel.com>, devel@open-fcoe.org
55 Description: The FCoE bus. Attributes in this directory are control interfaces.
6
+
67 Attributes:
78
8
- ctlr_create: 'FCoE Controller' instance creation interface. Writing an
9
+ ctlr_create:
10
+ 'FCoE Controller' instance creation interface. Writing an
911 <ifname> to this file will allocate and populate sysfs with a
1012 fcoe_ctlr_device (ctlr_X). The user can then configure any
1113 per-port settings and finally write to the fcoe_ctlr_device's
1214 'start' attribute to begin the kernel's discovery and login
1315 process.
1416
15
- ctlr_destroy: 'FCoE Controller' instance removal interface. Writing a
17
+ ctlr_destroy:
18
+ 'FCoE Controller' instance removal interface. Writing a
1619 fcoe_ctlr_device's sysfs name to this file will log the
1720 fcoe_ctlr_device out of the fabric or otherwise connected
1821 FCoE devices. It will also free all kernel memory allocated
....@@ -32,11 +35,13 @@
3235
3336 Attributes:
3437
35
- fcf_dev_loss_tmo: Device loss timeout period (see below). Changing
38
+ fcf_dev_loss_tmo:
39
+ Device loss timeout period (see below). Changing
3640 this value will change the dev_loss_tmo for all
3741 FCFs discovered by this controller.
3842
39
- mode: Display or change the FCoE Controller's mode. Possible
43
+ mode:
44
+ Display or change the FCoE Controller's mode. Possible
4045 modes are 'Fabric' and 'VN2VN'. If a FCoE Controller
4146 is started in 'Fabric' mode then FIP FCF discovery is
4247 initiated and ultimately a fabric login is attempted.
....@@ -44,23 +49,30 @@
4449 FIP VN2VN discovery and login is performed. A FCoE
4550 Controller only supports one mode at a time.
4651
47
- enabled: Whether an FCoE controller is enabled or disabled.
52
+ enabled:
53
+ Whether an FCoE controller is enabled or disabled.
4854 0 if disabled, 1 if enabled. Writing either 0 or 1
4955 to this file will enable or disable the FCoE controller.
5056
51
- lesb/link_fail: Link Error Status Block (LESB) link failure count.
57
+ lesb/link_fail:
58
+ Link Error Status Block (LESB) link failure count.
5259
53
- lesb/vlink_fail: Link Error Status Block (LESB) virtual link
60
+ lesb/vlink_fail:
61
+ Link Error Status Block (LESB) virtual link
5462 failure count.
5563
56
- lesb/miss_fka: Link Error Status Block (LESB) missed FCoE
64
+ lesb/miss_fka:
65
+ Link Error Status Block (LESB) missed FCoE
5766 Initialization Protocol (FIP) Keep-Alives (FKA).
5867
59
- lesb/symb_err: Link Error Status Block (LESB) symbolic error count.
68
+ lesb/symb_err:
69
+ Link Error Status Block (LESB) symbolic error count.
6070
61
- lesb/err_block: Link Error Status Block (LESB) block error count.
71
+ lesb/err_block:
72
+ Link Error Status Block (LESB) block error count.
6273
63
- lesb/fcs_error: Link Error Status Block (LESB) Fibre Channel
74
+ lesb/fcs_error:
75
+ Link Error Status Block (LESB) Fibre Channel
6476 Services error count.
6577
6678 Notes: ctlr_X (global increment starting at 0)
....@@ -75,31 +87,41 @@
7587 Fibre Channel frames into a FC fabric. It can also take
7688 outbound FC frames and pack them in Ethernet packets to
7789 be sent to their destination on the Ethernet segment.
90
+
7891 Attributes:
7992
80
- fabric_name: Identifies the fabric that the FCF services.
93
+ fabric_name:
94
+ Identifies the fabric that the FCF services.
8195
82
- switch_name: Identifies the FCF.
96
+ switch_name:
97
+ Identifies the FCF.
8398
84
- priority: The switch's priority amongst other FCFs on the same
99
+ priority:
100
+ The switch's priority amongst other FCFs on the same
85101 fabric.
86102
87
- selected: 1 indicates that the switch has been selected for use;
103
+ selected:
104
+ 1 indicates that the switch has been selected for use;
88105 0 indicates that the switch will not be used.
89106
90
- fc_map: The Fibre Channel MAP
107
+ fc_map:
108
+ The Fibre Channel MAP
91109
92
- vfid: The Virtual Fabric ID
110
+ vfid:
111
+ The Virtual Fabric ID
93112
94
- mac: The FCF's MAC address
113
+ mac:
114
+ The FCF's MAC address
95115
96
- fka_period: The FIP Keep-Alive period
116
+ fka_period:
117
+ The FIP Keep-Alive period
97118
98119 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
120
+
121
+ - "Unknown" - Initialization value
122
+ - "Disconnected" - No link to the FCF/fabric
123
+ - "Connected" - Host is connected to the FCF
124
+ - "Deleted" - FCF is being removed from the system
103125
104126 dev_loss_tmo: The device loss timeout period for this FCF.
105127