diff options
Diffstat (limited to 'Documentation/ABI/testing/sysfs-class-mic.txt')
-rw-r--r-- | Documentation/ABI/testing/sysfs-class-mic.txt | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/Documentation/ABI/testing/sysfs-class-mic.txt b/Documentation/ABI/testing/sysfs-class-mic.txt index 13f48afc534f..d45eed2bf128 100644 --- a/Documentation/ABI/testing/sysfs-class-mic.txt +++ b/Documentation/ABI/testing/sysfs-class-mic.txt | |||
@@ -41,18 +41,15 @@ Description: | |||
41 | When read, this entry provides the current state of an Intel | 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 | 42 | MIC device in the context of the card OS. Possible values that |
43 | will be read are: | 43 | will be read are: |
44 | "offline" - The MIC device is ready to boot the card OS. On | 44 | "ready" - The MIC device is ready to boot the card OS. On |
45 | reading this entry after an OSPM resume, a "boot" has to be | 45 | reading this entry after an OSPM resume, a "boot" has to be |
46 | written to this entry if the card was previously shutdown | 46 | written to this entry if the card was previously shutdown |
47 | during OSPM suspend. | 47 | during OSPM suspend. |
48 | "online" - The MIC device has initiated booting a card OS. | 48 | "booting" - The MIC device has initiated booting a card OS. |
49 | "online" - The MIC device has completed boot and is online | ||
49 | "shutting_down" - The card OS is shutting down. | 50 | "shutting_down" - The card OS is shutting down. |
51 | "resetting" - A reset has been initiated for the MIC device | ||
50 | "reset_failed" - The MIC device has failed to reset. | 52 | "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 | 53 | ||
57 | When written, this sysfs entry triggers different state change | 54 | When written, this sysfs entry triggers different state change |
58 | operations depending upon the current state of the card OS. | 55 | operations depending upon the current state of the card OS. |
@@ -62,8 +59,6 @@ Description: | |||
62 | sysfs entries. | 59 | sysfs entries. |
63 | "reset" - Initiates device reset. | 60 | "reset" - Initiates device reset. |
64 | "shutdown" - Initiates card OS shutdown. | 61 | "shutdown" - Initiates card OS shutdown. |
65 | "suspend" - Initiates card OS shutdown and also marks the card | ||
66 | as suspended. | ||
67 | 62 | ||
68 | What: /sys/class/mic/mic(x)/shutdown_status | 63 | What: /sys/class/mic/mic(x)/shutdown_status |
69 | Date: October 2013 | 64 | Date: October 2013 |
@@ -126,7 +121,7 @@ Description: | |||
126 | the card. This sysfs entry can be written with the following | 121 | the card. This sysfs entry can be written with the following |
127 | valid strings: | 122 | valid strings: |
128 | a) linux - Boot a Linux image. | 123 | a) linux - Boot a Linux image. |
129 | b) elf - Boot an elf image for flash updates. | 124 | b) flash - Boot an image for flash updates. |
130 | 125 | ||
131 | What: /sys/class/mic/mic(x)/log_buf_addr | 126 | What: /sys/class/mic/mic(x)/log_buf_addr |
132 | Date: October 2013 | 127 | Date: October 2013 |
@@ -155,3 +150,17 @@ Description: | |||
155 | daemon to set the log buffer length address. The correct log | 150 | daemon to set the log buffer length address. The correct log |
156 | buffer length address to be written can be found in the | 151 | buffer length address to be written can be found in the |
157 | System.map file of the card OS. | 152 | System.map file of the card OS. |
153 | |||
154 | What: /sys/class/mic/mic(x)/heartbeat_enable | ||
155 | Date: March 2015 | ||
156 | KernelVersion: 3.20 | ||
157 | Contact: Ashutosh Dixit <ashutosh.dixit@intel.com> | ||
158 | Description: | ||
159 | The MIC drivers detect and inform user space about card crashes | ||
160 | via a heartbeat mechanism (see the description of | ||
161 | shutdown_status above). User space can turn off this | ||
162 | notification by setting heartbeat_enable to 0 and enable it by | ||
163 | setting this entry to 1. If this notification is disabled it is | ||
164 | the responsibility of user space to detect card crashes via | ||
165 | alternative means such as a network ping. This setting is | ||
166 | enabled by default. | ||