sysfs-bus-fcoe 4.6 KB

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