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