summaryrefslogtreecommitdiffstats
path: root/Documentation/misc-devices/mei/mei-client-bus.txt
diff options
context:
space:
mode:
authorJulian Brost <linux-kernel@0x4a42.net>2015-01-12 00:58:06 +0100
committerJonathan Corbet <corbet@lwn.net>2015-01-29 12:55:03 -0700
commitcfba67841b7daf254b76fbe467cf6be40e15f6b8 (patch)
tree4edd89c1ea5c3d77594f0ca14ab3d4d16419a2c4 /Documentation/misc-devices/mei/mei-client-bus.txt
parentac3e8ea1d3a6b204f78e2e828f85b15d25617515 (diff)
downloadop-kernel-dev-cfba67841b7daf254b76fbe467cf6be40e15f6b8.zip
op-kernel-dev-cfba67841b7daf254b76fbe467cf6be40e15f6b8.tar.gz
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/misc-devices/mei/mei-client-bus.txt')
-rw-r--r--Documentation/misc-devices/mei/mei-client-bus.txt7
1 files changed, 5 insertions, 2 deletions
diff --git a/Documentation/misc-devices/mei/mei-client-bus.txt b/Documentation/misc-devices/mei/mei-client-bus.txt
index f83910a..6ca486b 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:
OpenPOWER on IntegriCloud