0001 What: /sys/class/mic/
0002 Date: October 2013
0003 KernelVersion: 3.13
0004 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
0005 Description:
0006 The mic class directory belongs to Intel MIC devices and
0007 provides information per MIC device. An Intel MIC device is a
0008 PCIe form factor add-in Coprocessor card based on the Intel Many
0009 Integrated Core (MIC) architecture that runs a Linux OS.
0010
0011 What: /sys/class/mic/mic<X>
0012 Date: October 2013
0013 KernelVersion: 3.13
0014 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
0015 Description:
0016 The directories /sys/class/mic/mic0, /sys/class/mic/mic1 etc.,
0017 represent MIC devices (0,1,..etc). Each directory has
0018 information specific to that MIC device.
0019
0020 What: /sys/class/mic/mic<X>/family
0021 Date: October 2013
0022 KernelVersion: 3.13
0023 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
0024 Description:
0025 Provides information about the Coprocessor family for an Intel
0026 MIC device. For example - "x100"
0027
0028 What: /sys/class/mic/mic<X>/stepping
0029 Date: October 2013
0030 KernelVersion: 3.13
0031 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
0032 Description:
0033 Provides information about the silicon stepping for an Intel
0034 MIC device. For example - "A0" or "B0"
0035
0036 What: /sys/class/mic/mic<X>/state
0037 Date: October 2013
0038 KernelVersion: 3.13
0039 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
0040 Description:
0041 When read, this entry provides the current state of an Intel
0042 MIC device in the context of the card OS. Possible values that
0043 will be read are:
0044
0045
0046 =============== ===============================================
0047 "ready" The MIC device is ready to boot the card OS.
0048 On reading this entry after an OSPM resume,
0049 a "boot" has to be written to this entry if
0050 the card was previously shutdown during OSPM
0051 suspend.
0052 "booting" The MIC device has initiated booting a card OS.
0053 "online" The MIC device has completed boot and is online
0054 "shutting_down" The card OS is shutting down.
0055 "resetting" A reset has been initiated for the MIC device
0056 "reset_failed" The MIC device has failed to reset.
0057 =============== ===============================================
0058
0059 When written, this sysfs entry triggers different state change
0060 operations depending upon the current state of the card OS.
0061 Acceptable values are:
0062
0063
0064 ========== ===================================================
0065 "boot" Boot the card OS image specified by the combination
0066 of firmware, ramdisk, cmdline and bootmode
0067 sysfs entries.
0068 "reset" Initiates device reset.
0069 "shutdown" Initiates card OS shutdown.
0070 ========== ===================================================
0071
0072 What: /sys/class/mic/mic<X>/shutdown_status
0073 Date: October 2013
0074 KernelVersion: 3.13
0075 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
0076 Description:
0077 An Intel MIC device runs a Linux OS during its operation. This
0078 OS can shutdown because of various reasons. When read, this
0079 entry provides the status on why the card OS was shutdown.
0080 Possible values are:
0081
0082 ========== ===================================================
0083 "nop" shutdown status is not applicable, when the card OS
0084 is "online"
0085 "crashed" Shutdown because of a HW or SW crash.
0086 "halted" Shutdown because of a halt command.
0087 "poweroff" Shutdown because of a poweroff command.
0088 "restart" Shutdown because of a restart command.
0089 ========== ===================================================
0090
0091 What: /sys/class/mic/mic<X>/cmdline
0092 Date: October 2013
0093 KernelVersion: 3.13
0094 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
0095 Description:
0096 An Intel MIC device runs a Linux OS during its operation. Before
0097 booting this card OS, it is possible to pass kernel command line
0098 options to configure various features in it, similar to
0099 self-bootable machines. When read, this entry provides
0100 information about the current kernel command line options set to
0101 boot the card OS. This entry can be written to change the
0102 existing kernel command line options. Typically, the user would
0103 want to read the current command line options, append new ones
0104 or modify existing ones and then write the whole kernel command
0105 line back to this entry.
0106
0107 What: /sys/class/mic/mic<X>/firmware
0108 Date: October 2013
0109 KernelVersion: 3.13
0110 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
0111 Description:
0112 When read, this sysfs entry provides the path name under
0113 /lib/firmware/ where the firmware image to be booted on the
0114 card can be found. The entry can be written to change the
0115 firmware image location under /lib/firmware/.
0116
0117 What: /sys/class/mic/mic<X>/ramdisk
0118 Date: October 2013
0119 KernelVersion: 3.13
0120 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
0121 Description:
0122 When read, this sysfs entry provides the path name under
0123 /lib/firmware/ where the ramdisk image to be used during card
0124 OS boot can be found. The entry can be written to change
0125 the ramdisk image location under /lib/firmware/.
0126
0127 What: /sys/class/mic/mic<X>/bootmode
0128 Date: October 2013
0129 KernelVersion: 3.13
0130 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
0131 Description:
0132 When read, this sysfs entry provides the current bootmode for
0133 the card. This sysfs entry can be written with the following
0134 valid strings:
0135 a) linux - Boot a Linux image.
0136 b) flash - Boot an image for flash updates.
0137
0138 What: /sys/class/mic/mic<X>/log_buf_addr
0139 Date: October 2013
0140 KernelVersion: 3.13
0141 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
0142 Description:
0143 An Intel MIC device runs a Linux OS during its operation. For
0144 debugging purpose and early kernel boot messages, the user can
0145 access the card OS log buffer via debugfs. When read, this entry
0146 provides the kernel virtual address of the buffer where the card
0147 OS log buffer can be read. This entry is written by the host
0148 configuration daemon to set the log buffer address. The correct
0149 log buffer address to be written can be found in the System.map
0150 file of the card OS.
0151
0152 What: /sys/class/mic/mic<X>/log_buf_len
0153 Date: October 2013
0154 KernelVersion: 3.13
0155 Contact: Sudeep Dutt <sudeep.dutt@intel.com>
0156 Description:
0157 An Intel MIC device runs a Linux OS during its operation. For
0158 debugging purpose and early kernel boot messages, the user can
0159 access the card OS log buffer via debugfs. When read, this entry
0160 provides the kernel virtual address where the card OS log buffer
0161 length can be read. This entry is written by host configuration
0162 daemon to set the log buffer length address. The correct log
0163 buffer length address to be written can be found in the
0164 System.map file of the card OS.
0165
0166 What: /sys/class/mic/mic<X>/heartbeat_enable
0167 Date: March 2015
0168 KernelVersion: 4.4
0169 Contact: Ashutosh Dixit <ashutosh.dixit@intel.com>
0170 Description:
0171 The MIC drivers detect and inform user space about card crashes
0172 via a heartbeat mechanism (see the description of
0173 shutdown_status above). User space can turn off this
0174 notification by setting heartbeat_enable to 0 and enable it by
0175 setting this entry to 1. If this notification is disabled it is
0176 the responsibility of user space to detect card crashes via
0177 alternative means such as a network ping. This setting is
0178 enabled by default.
