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