sysfs-bus-fcoe 4.5 KB

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