redonkable
/
alistair23-linux
1
0
Fork 0
Code Releases Activity

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>
hifive-unleashed-5.1
Julian Brost 2015-01-12 00:58:06 +01:00 committed by Jonathan Corbet
parent ac3e8ea1d3
commit cfba67841b
2 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/misc-devices/mei/mei-client-bus.txt
View File

@ -1,9 +1,10 @@
Intel(R) Management Engine (ME) Client bus API Intel(R) Management Engine (ME) Client bus API
=============================================== ==============================================
Rationale Rationale
========= =========
MEI misc character device is useful for dedicated applications to send and receive 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. 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 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 MEI CL bus API
=========== ==============
A driver implementation for an MEI Client is very similar to existing bus 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 based device drivers. The driver registers itself as an MEI CL bus driver through
the mei_cl_driver structure: the mei_cl_driver structure:
@ -55,6 +57,7 @@ received buffers.
Example Example
======= =======
As a theoretical example let's pretend the ME comes with a "contact" NFC IP. 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: The driver init and exit routines for this device would look like:

27
Documentation/misc-devices/mei/mei.txt
View File

@ -1,8 +1,8 @@
Intel(R) Management Engine Interface (Intel(R) MEI) Intel(R) Management Engine Interface (Intel(R) MEI)
======================= ===================================================
Introduction Introduction
======================= ============
The Intel Management Engine (Intel ME) is an isolated and protected computing The Intel Management Engine (Intel ME) is an isolated and protected computing
resource (Co-processor) residing inside certain Intel chipsets. The Intel ME 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: For more information about Intel AMT:
http://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide http://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide
Intel MEI Driver Intel MEI Driver
======================= ================
The driver exposes a misc device called /dev/mei. 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); close(fd);
IOCTL:
====== IOCTL
=====
The Intel MEI Driver supports the following IOCTL command: The Intel MEI Driver supports the following IOCTL command:
IOCTL_MEI_CONNECT_CLIENT Connect to firmware Feature (client). 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 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). 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) 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/ 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. The Intel AMT Watchdog is an OS Health (Hang/Crash) watchdog.
Whenever the OS hangs or crashes, Intel AMT will send an event Whenever the OS hangs or crashes, Intel AMT will send an event
to any subscriber to this event. This mechanism means that 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), If the Intel AMT Watchdog feature does not exist (i.e. the connection failed),
the Intel MEI driver will disable the sending of heartbeats. the Intel MEI driver will disable the sending of heartbeats.
Supported Chipsets:
Supported Chipsets
================== ==================
7 Series Chipset Family 7 Series Chipset Family
6 Series Chipset Family 6 Series Chipset Family
5 Series Chipset Family 5 Series Chipset Family