summaryrefslogtreecommitdiff
path: root/Documentation/ABI/testing/sysfs-class-mic.txt
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>2019-07-09 13:34:37 +0300
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2019-07-25 15:38:38 +0300
commit0854d589aa91c68f676f55e087be549eacaaa408 (patch)
treee837d8fdb22efe311f7e1d827b5126de7b1e87ab /Documentation/ABI/testing/sysfs-class-mic.txt
parentbc83f79bd2119230888fb8574639d5a51b38f903 (diff)
downloadlinux-0854d589aa91c68f676f55e087be549eacaaa408.tar.xz
docs: ABI: remove extension from sysfs-class-mic.txt
Files under ABI doesn't end with a .txt extension. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Link: https://lore.kernel.org/r/5113d1ae9d2dd3bc685bbb65655abd67e26f48c4.1562668471.git.mchehab+samsung@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/ABI/testing/sysfs-class-mic.txt')
-rw-r--r--Documentation/ABI/testing/sysfs-class-mic.txt166
1 files changed, 0 insertions, 166 deletions
diff --git a/Documentation/ABI/testing/sysfs-class-mic.txt b/Documentation/ABI/testing/sysfs-class-mic.txt
deleted file mode 100644
index 6ef682603179..000000000000
--- a/Documentation/ABI/testing/sysfs-class-mic.txt
+++ /dev/null
@@ -1,166 +0,0 @@
-What: /sys/class/mic/
-Date: October 2013
-KernelVersion: 3.13
-Contact: Sudeep Dutt <sudeep.dutt@intel.com>
-Description:
- The mic class directory belongs to Intel MIC devices and
- provides information per MIC device. An Intel MIC device is a
- PCIe form factor add-in Coprocessor card based on the Intel Many
- Integrated Core (MIC) architecture that runs a Linux OS.
-
-What: /sys/class/mic/mic(x)
-Date: October 2013
-KernelVersion: 3.13
-Contact: Sudeep Dutt <sudeep.dutt@intel.com>
-Description:
- The directories /sys/class/mic/mic0, /sys/class/mic/mic1 etc.,
- represent MIC devices (0,1,..etc). Each directory has
- information specific to that MIC device.
-
-What: /sys/class/mic/mic(x)/family
-Date: October 2013
-KernelVersion: 3.13
-Contact: Sudeep Dutt <sudeep.dutt@intel.com>
-Description:
- Provides information about the Coprocessor family for an Intel
- MIC device. For example - "x100"
-
-What: /sys/class/mic/mic(x)/stepping
-Date: October 2013
-KernelVersion: 3.13
-Contact: Sudeep Dutt <sudeep.dutt@intel.com>
-Description:
- Provides information about the silicon stepping for an Intel
- MIC device. For example - "A0" or "B0"
-
-What: /sys/class/mic/mic(x)/state
-Date: October 2013
-KernelVersion: 3.13
-Contact: Sudeep Dutt <sudeep.dutt@intel.com>
-Description:
- When read, this entry provides the current state of an Intel
- MIC device in the context of the card OS. Possible values that
- will be read are:
- "ready" - The MIC device is ready to boot the card OS. On
- reading this entry after an OSPM resume, a "boot" has to be
- written to this entry if the card was previously shutdown
- during OSPM suspend.
- "booting" - The MIC device has initiated booting a card OS.
- "online" - The MIC device has completed boot and is online
- "shutting_down" - The card OS is shutting down.
- "resetting" - A reset has been initiated for the MIC device
- "reset_failed" - The MIC device has failed to reset.
-
- When written, this sysfs entry triggers different state change
- operations depending upon the current state of the card OS.
- Acceptable values are:
- "boot" - Boot the card OS image specified by the combination
- of firmware, ramdisk, cmdline and bootmode
- sysfs entries.
- "reset" - Initiates device reset.
- "shutdown" - Initiates card OS shutdown.
-
-What: /sys/class/mic/mic(x)/shutdown_status
-Date: October 2013
-KernelVersion: 3.13
-Contact: Sudeep Dutt <sudeep.dutt@intel.com>
-Description:
- An Intel MIC device runs a Linux OS during its operation. This
- OS can shutdown because of various reasons. When read, this
- entry provides the status on why the card OS was shutdown.
- Possible values are:
- "nop" - shutdown status is not applicable, when the card OS is
- "online"
- "crashed" - Shutdown because of a HW or SW crash.
- "halted" - Shutdown because of a halt command.
- "poweroff" - Shutdown because of a poweroff command.
- "restart" - Shutdown because of a restart command.
-
-What: /sys/class/mic/mic(x)/cmdline
-Date: October 2013
-KernelVersion: 3.13
-Contact: Sudeep Dutt <sudeep.dutt@intel.com>
-Description:
- An Intel MIC device runs a Linux OS during its operation. Before
- booting this card OS, it is possible to pass kernel command line
- options to configure various features in it, similar to
- self-bootable machines. When read, this entry provides
- information about the current kernel command line options set to
- boot the card OS. This entry can be written to change the
- existing kernel command line options. Typically, the user would
- want to read the current command line options, append new ones
- or modify existing ones and then write the whole kernel command
- line back to this entry.
-
-What: /sys/class/mic/mic(x)/firmware
-Date: October 2013
-KernelVersion: 3.13
-Contact: Sudeep Dutt <sudeep.dutt@intel.com>
-Description:
- When read, this sysfs entry provides the path name under
- /lib/firmware/ where the firmware image to be booted on the
- card can be found. The entry can be written to change the
- firmware image location under /lib/firmware/.
-
-What: /sys/class/mic/mic(x)/ramdisk
-Date: October 2013
-KernelVersion: 3.13
-Contact: Sudeep Dutt <sudeep.dutt@intel.com>
-Description:
- When read, this sysfs entry provides the path name under
- /lib/firmware/ where the ramdisk image to be used during card
- OS boot can be found. The entry can be written to change
- the ramdisk image location under /lib/firmware/.
-
-What: /sys/class/mic/mic(x)/bootmode
-Date: October 2013
-KernelVersion: 3.13
-Contact: Sudeep Dutt <sudeep.dutt@intel.com>
-Description:
- When read, this sysfs entry provides the current bootmode for
- the card. This sysfs entry can be written with the following
- valid strings:
- a) linux - Boot a Linux image.
- b) flash - Boot an image for flash updates.
-
-What: /sys/class/mic/mic(x)/log_buf_addr
-Date: October 2013
-KernelVersion: 3.13
-Contact: Sudeep Dutt <sudeep.dutt@intel.com>
-Description:
- An Intel MIC device runs a Linux OS during its operation. For
- debugging purpose and early kernel boot messages, the user can
- access the card OS log buffer via debugfs. When read, this entry
- provides the kernel virtual address of the buffer where the card
- OS log buffer can be read. This entry is written by the host
- configuration daemon to set the log buffer address. The correct
- log buffer address to be written can be found in the System.map
- file of the card OS.
-
-What: /sys/class/mic/mic(x)/log_buf_len
-Date: October 2013
-KernelVersion: 3.13
-Contact: Sudeep Dutt <sudeep.dutt@intel.com>
-Description:
- An Intel MIC device runs a Linux OS during its operation. For
- debugging purpose and early kernel boot messages, the user can
- access the card OS log buffer via debugfs. When read, this entry
- provides the kernel virtual address where the card OS log buffer
- length can be read. This entry is written by host configuration
- daemon to set the log buffer length address. The correct log
- buffer length address to be written can be found in the
- System.map file of the card OS.
-
-What: /sys/class/mic/mic(x)/heartbeat_enable
-Date: March 2015
-KernelVersion: 4.4
-Contact: Ashutosh Dixit <ashutosh.dixit@intel.com>
-Description:
- The MIC drivers detect and inform user space about card crashes
- via a heartbeat mechanism (see the description of
- shutdown_status above). User space can turn off this
- notification by setting heartbeat_enable to 0 and enable it by
- setting this entry to 1. If this notification is disabled it is
- the responsibility of user space to detect card crashes via
- alternative means such as a network ping. This setting is
- enabled by default.