aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJulian Brost <linux-kernel@0x4a42.net>2015-01-11 18:58:06 -0500
committerJonathan Corbet <corbet@lwn.net>2015-01-29 14:55:03 -0500
commitcfba67841b7daf254b76fbe467cf6be40e15f6b8 (patch)
tree4edd89c1ea5c3d77594f0ca14ab3d4d16419a2c4
parentac3e8ea1d3a6b204f78e2e828f85b15d25617515 (diff)
Documentation/misc-devices/mei: Fix formatting of headings.
Make the heading underlines fit the length of the heading, remove colons at the end of headings and consistently place an empty line after each heading and two empty lines before each that is preceded by a paragraph. Reviewed-by: Jeremiah Mahler <jmmahler@gmail.com> Signed-off-by: Julian Brost <linux-kernel@0x4a42.net> Signed-off-by: Fabian Hofmann <fabian.hofmann@fau.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-rw-r--r--Documentation/misc-devices/mei/mei-client-bus.txt7
-rw-r--r--Documentation/misc-devices/mei/mei.txt27
2 files changed, 22 insertions, 12 deletions
diff --git a/Documentation/misc-devices/mei/mei-client-bus.txt b/Documentation/misc-devices/mei/mei-client-bus.txt
index f83910a8ce76..6ca486bd0d14 100644
--- a/Documentation/misc-devices/mei/mei-client-bus.txt
+++ b/Documentation/misc-devices/mei/mei-client-bus.txt
@@ -1,9 +1,10 @@
1Intel(R) Management Engine (ME) Client bus API 1Intel(R) Management Engine (ME) Client bus API
2=============================================== 2==============================================
3 3
4 4
5Rationale 5Rationale
6========= 6=========
7
7MEI misc character device is useful for dedicated applications to send and receive 8MEI misc character device is useful for dedicated applications to send and receive
8data to the many FW appliance found in Intel's ME from the user space. 9data to the many FW appliance found in Intel's ME from the user space.
9However for some of the ME functionalities it make sense to leverage existing software 10However for some of the ME functionalities it make sense to leverage existing software
@@ -17,7 +18,8 @@ the existing code.
17 18
18 19
19MEI CL bus API 20MEI CL bus API
20=========== 21==============
22
21A driver implementation for an MEI Client is very similar to existing bus 23A driver implementation for an MEI Client is very similar to existing bus
22based device drivers. The driver registers itself as an MEI CL bus driver through 24based device drivers. The driver registers itself as an MEI CL bus driver through
23the mei_cl_driver structure: 25the mei_cl_driver structure:
@@ -55,6 +57,7 @@ received buffers.
55 57
56Example 58Example
57======= 59=======
60
58As a theoretical example let's pretend the ME comes with a "contact" NFC IP. 61As a theoretical example let's pretend the ME comes with a "contact" NFC IP.
59The driver init and exit routines for this device would look like: 62The driver init and exit routines for this device would look like:
60 63
diff --git a/Documentation/misc-devices/mei/mei.txt b/Documentation/misc-devices/mei/mei.txt
index 15bba1aeba9a..9a96af170ff7 100644
--- a/Documentation/misc-devices/mei/mei.txt
+++ b/Documentation/misc-devices/mei/mei.txt
@@ -1,8 +1,8 @@
1Intel(R) Management Engine Interface (Intel(R) MEI) 1Intel(R) Management Engine Interface (Intel(R) MEI)
2======================= 2===================================================
3 3
4Introduction 4Introduction
5======================= 5============
6 6
7The Intel Management Engine (Intel ME) is an isolated and protected computing 7The Intel Management Engine (Intel ME) is an isolated and protected computing
8resource (Co-processor) residing inside certain Intel chipsets. The Intel ME 8resource (Co-processor) residing inside certain Intel chipsets. The Intel ME
@@ -44,8 +44,9 @@ HTTP/S that are received from a remote management console application.
44For more information about Intel AMT: 44For more information about Intel AMT:
45http://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide 45http://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide
46 46
47
47Intel MEI Driver 48Intel MEI Driver
48======================= 49================
49 50
50The driver exposes a misc device called /dev/mei. 51The driver exposes a misc device called /dev/mei.
51 52
@@ -91,8 +92,10 @@ A code snippet for an application communicating with Intel AMTHI client:
91 [...] 92 [...]
92 close(fd); 93 close(fd);
93 94
94IOCTL: 95
95====== 96IOCTL
97=====
98
96The Intel MEI Driver supports the following IOCTL command: 99The Intel MEI Driver supports the following IOCTL command:
97 IOCTL_MEI_CONNECT_CLIENT Connect to firmware Feature (client). 100 IOCTL_MEI_CONNECT_CLIENT Connect to firmware Feature (client).
98 101
@@ -122,8 +125,9 @@ The Intel MEI Driver supports the following IOCTL command:
122 data that can be sent or received. (e.g. if MTU=2K, can send 125 data that can be sent or received. (e.g. if MTU=2K, can send
123 requests up to bytes 2k and received responses up to 2k bytes). 126 requests up to bytes 2k and received responses up to 2k bytes).
124 127
125Intel ME Applications: 128
126============== 129Intel ME Applications
130=====================
127 131
1281) Intel Local Management Service (Intel LMS) 1321) Intel Local Management Service (Intel LMS)
129 133
@@ -172,8 +176,9 @@ Intel ME Applications:
172 http://software.intel.com/en-us/articles/download-the-latest-intel-amt-open-source-drivers/ 176 http://software.intel.com/en-us/articles/download-the-latest-intel-amt-open-source-drivers/
173 177
174 178
175Intel AMT OS Health Watchdog: 179Intel AMT OS Health Watchdog
176============================= 180============================
181
177The Intel AMT Watchdog is an OS Health (Hang/Crash) watchdog. 182The Intel AMT Watchdog is an OS Health (Hang/Crash) watchdog.
178Whenever the OS hangs or crashes, Intel AMT will send an event 183Whenever the OS hangs or crashes, Intel AMT will send an event
179to any subscriber to this event. This mechanism means that 184to any subscriber to this event. This mechanism means that
@@ -192,8 +197,10 @@ watchdog is 120 seconds.
192If the Intel AMT Watchdog feature does not exist (i.e. the connection failed), 197If the Intel AMT Watchdog feature does not exist (i.e. the connection failed),
193the Intel MEI driver will disable the sending of heartbeats. 198the Intel MEI driver will disable the sending of heartbeats.
194 199
195Supported Chipsets: 200
201Supported Chipsets
196================== 202==================
203
1977 Series Chipset Family 2047 Series Chipset Family
1986 Series Chipset Family 2056 Series Chipset Family
1995 Series Chipset Family 2065 Series Chipset Family