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