diff options
author | Julian Brost <linux-kernel@0x4a42.net> | 2015-01-12 00:58:06 +0100 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2015-01-29 12:55:03 -0700 |
commit | cfba67841b7daf254b76fbe467cf6be40e15f6b8 (patch) | |
tree | 4edd89c1ea5c3d77594f0ca14ab3d4d16419a2c4 /Documentation | |
parent | ac3e8ea1d3a6b204f78e2e828f85b15d25617515 (diff) | |
download | linux-stable-cfba67841b7daf254b76fbe467cf6be40e15f6b8.tar.gz linux-stable-cfba67841b7daf254b76fbe467cf6be40e15f6b8.tar.bz2 linux-stable-cfba67841b7daf254b76fbe467cf6be40e15f6b8.zip |
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>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/misc-devices/mei/mei-client-bus.txt | 7 | ||||
-rw-r--r-- | Documentation/misc-devices/mei/mei.txt | 27 |
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 @@ Intel(R) Management Engine (ME) Client bus API -=============================================== +============================================== Rationale ========= + MEI misc character device is useful for dedicated applications to send and receive data to the many FW appliance found in Intel's ME from the user space. However for some of the ME functionalities it make sense to leverage existing software @@ -17,7 +18,8 @@ the existing code. MEI CL bus API -=========== +============== + A driver implementation for an MEI Client is very similar to existing bus based device drivers. The driver registers itself as an MEI CL bus driver through the mei_cl_driver structure: @@ -55,6 +57,7 @@ received buffers. Example ======= + As a theoretical example let's pretend the ME comes with a "contact" NFC IP. The driver init and exit routines for this device would look like: 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 @@ Intel(R) Management Engine Interface (Intel(R) MEI) -======================= +=================================================== Introduction -======================= +============ The Intel Management Engine (Intel ME) is an isolated and protected computing resource (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. For more information about Intel AMT: http://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide + Intel MEI Driver -======================= +================ The driver exposes a misc device called /dev/mei. @@ -91,8 +92,10 @@ A code snippet for an application communicating with Intel AMTHI client: [...] close(fd); -IOCTL: -====== + +IOCTL +===== + The Intel MEI Driver supports the following IOCTL command: IOCTL_MEI_CONNECT_CLIENT Connect to firmware Feature (client). @@ -122,8 +125,9 @@ The Intel MEI Driver supports the following IOCTL command: data that can be sent or received. (e.g. if MTU=2K, can send requests up to bytes 2k and received responses up to 2k bytes). -Intel ME Applications: -============== + +Intel ME Applications +===================== 1) Intel Local Management Service (Intel LMS) @@ -172,8 +176,9 @@ Intel ME Applications: http://software.intel.com/en-us/articles/download-the-latest-intel-amt-open-source-drivers/ -Intel AMT OS Health Watchdog: -============================= +Intel AMT OS Health Watchdog +============================ + The Intel AMT Watchdog is an OS Health (Hang/Crash) watchdog. Whenever the OS hangs or crashes, Intel AMT will send an event to any subscriber to this event. This mechanism means that @@ -192,8 +197,10 @@ watchdog is 120 seconds. If the Intel AMT Watchdog feature does not exist (i.e. the connection failed), the Intel MEI driver will disable the sending of heartbeats. -Supported Chipsets: + +Supported Chipsets ================== + 7 Series Chipset Family 6 Series Chipset Family 5 Series Chipset Family |