sysfs-class-mic 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. What: /sys/class/mic/
  2. Date: October 2013
  3. KernelVersion: 3.13
  4. Contact: Sudeep Dutt <sudeep.dutt@intel.com>
  5. Description:
  6. The mic class directory belongs to Intel MIC devices and
  7. provides information per MIC device. An Intel MIC device is a
  8. PCIe form factor add-in Coprocessor card based on the Intel Many
  9. Integrated Core (MIC) architecture that runs a Linux OS.
  10. What: /sys/class/mic/mic(x)
  11. Date: October 2013
  12. KernelVersion: 3.13
  13. Contact: Sudeep Dutt <sudeep.dutt@intel.com>
  14. Description:
  15. The directories /sys/class/mic/mic0, /sys/class/mic/mic1 etc.,
  16. represent MIC devices (0,1,..etc). Each directory has
  17. information specific to that MIC device.
  18. What: /sys/class/mic/mic(x)/family
  19. Date: October 2013
  20. KernelVersion: 3.13
  21. Contact: Sudeep Dutt <sudeep.dutt@intel.com>
  22. Description:
  23. Provides information about the Coprocessor family for an Intel
  24. MIC device. For example - "x100"
  25. What: /sys/class/mic/mic(x)/stepping
  26. Date: October 2013
  27. KernelVersion: 3.13
  28. Contact: Sudeep Dutt <sudeep.dutt@intel.com>
  29. Description:
  30. Provides information about the silicon stepping for an Intel
  31. MIC device. For example - "A0" or "B0"
  32. What: /sys/class/mic/mic(x)/state
  33. Date: October 2013
  34. KernelVersion: 3.13
  35. Contact: Sudeep Dutt <sudeep.dutt@intel.com>
  36. Description:
  37. When read, this entry provides the current state of an Intel
  38. MIC device in the context of the card OS. Possible values that
  39. will be read are:
  40. =============== ===============================================
  41. "ready" The MIC device is ready to boot the card OS.
  42. On reading this entry after an OSPM resume,
  43. a "boot" has to be written to this entry if
  44. the card was previously shutdown during OSPM
  45. suspend.
  46. "booting" The MIC device has initiated booting a card OS.
  47. "online" The MIC device has completed boot and is online
  48. "shutting_down" The card OS is shutting down.
  49. "resetting" A reset has been initiated for the MIC device
  50. "reset_failed" The MIC device has failed to reset.
  51. =============== ===============================================
  52. When written, this sysfs entry triggers different state change
  53. operations depending upon the current state of the card OS.
  54. Acceptable values are:
  55. ========== ===================================================
  56. "boot" Boot the card OS image specified by the combination
  57. of firmware, ramdisk, cmdline and bootmode
  58. sysfs entries.
  59. "reset" Initiates device reset.
  60. "shutdown" Initiates card OS shutdown.
  61. ========== ===================================================
  62. What: /sys/class/mic/mic(x)/shutdown_status
  63. Date: October 2013
  64. KernelVersion: 3.13
  65. Contact: Sudeep Dutt <sudeep.dutt@intel.com>
  66. Description:
  67. An Intel MIC device runs a Linux OS during its operation. This
  68. OS can shutdown because of various reasons. When read, this
  69. entry provides the status on why the card OS was shutdown.
  70. Possible values are:
  71. ========== ===================================================
  72. "nop" shutdown status is not applicable, when the card OS
  73. is "online"
  74. "crashed" Shutdown because of a HW or SW crash.
  75. "halted" Shutdown because of a halt command.
  76. "poweroff" Shutdown because of a poweroff command.
  77. "restart" Shutdown because of a restart command.
  78. ========== ===================================================
  79. What: /sys/class/mic/mic(x)/cmdline
  80. Date: October 2013
  81. KernelVersion: 3.13
  82. Contact: Sudeep Dutt <sudeep.dutt@intel.com>
  83. Description:
  84. An Intel MIC device runs a Linux OS during its operation. Before
  85. booting this card OS, it is possible to pass kernel command line
  86. options to configure various features in it, similar to
  87. self-bootable machines. When read, this entry provides
  88. information about the current kernel command line options set to
  89. boot the card OS. This entry can be written to change the
  90. existing kernel command line options. Typically, the user would
  91. want to read the current command line options, append new ones
  92. or modify existing ones and then write the whole kernel command
  93. line back to this entry.
  94. What: /sys/class/mic/mic(x)/firmware
  95. Date: October 2013
  96. KernelVersion: 3.13
  97. Contact: Sudeep Dutt <sudeep.dutt@intel.com>
  98. Description:
  99. When read, this sysfs entry provides the path name under
  100. /lib/firmware/ where the firmware image to be booted on the
  101. card can be found. The entry can be written to change the
  102. firmware image location under /lib/firmware/.
  103. What: /sys/class/mic/mic(x)/ramdisk
  104. Date: October 2013
  105. KernelVersion: 3.13
  106. Contact: Sudeep Dutt <sudeep.dutt@intel.com>
  107. Description:
  108. When read, this sysfs entry provides the path name under
  109. /lib/firmware/ where the ramdisk image to be used during card
  110. OS boot can be found. The entry can be written to change
  111. the ramdisk image location under /lib/firmware/.
  112. What: /sys/class/mic/mic(x)/bootmode
  113. Date: October 2013
  114. KernelVersion: 3.13
  115. Contact: Sudeep Dutt <sudeep.dutt@intel.com>
  116. Description:
  117. When read, this sysfs entry provides the current bootmode for
  118. the card. This sysfs entry can be written with the following
  119. valid strings:
  120. a) linux - Boot a Linux image.
  121. b) flash - Boot an image for flash updates.
  122. What: /sys/class/mic/mic(x)/log_buf_addr
  123. Date: October 2013
  124. KernelVersion: 3.13
  125. Contact: Sudeep Dutt <sudeep.dutt@intel.com>
  126. Description:
  127. An Intel MIC device runs a Linux OS during its operation. For
  128. debugging purpose and early kernel boot messages, the user can
  129. access the card OS log buffer via debugfs. When read, this entry
  130. provides the kernel virtual address of the buffer where the card
  131. OS log buffer can be read. This entry is written by the host
  132. configuration daemon to set the log buffer address. The correct
  133. log buffer address to be written can be found in the System.map
  134. file of the card OS.
  135. What: /sys/class/mic/mic(x)/log_buf_len
  136. Date: October 2013
  137. KernelVersion: 3.13
  138. Contact: Sudeep Dutt <sudeep.dutt@intel.com>
  139. Description:
  140. An Intel MIC device runs a Linux OS during its operation. For
  141. debugging purpose and early kernel boot messages, the user can
  142. access the card OS log buffer via debugfs. When read, this entry
  143. provides the kernel virtual address where the card OS log buffer
  144. length can be read. This entry is written by host configuration
  145. daemon to set the log buffer length address. The correct log
  146. buffer length address to be written can be found in the
  147. System.map file of the card OS.
  148. What: /sys/class/mic/mic(x)/heartbeat_enable
  149. Date: March 2015
  150. KernelVersion: 4.4
  151. Contact: Ashutosh Dixit <ashutosh.dixit@intel.com>
  152. Description:
  153. The MIC drivers detect and inform user space about card crashes
  154. via a heartbeat mechanism (see the description of
  155. shutdown_status above). User space can turn off this
  156. notification by setting heartbeat_enable to 0 and enable it by
  157. setting this entry to 1. If this notification is disabled it is
  158. the responsibility of user space to detect card crashes via
  159. alternative means such as a network ping. This setting is
  160. enabled by default.