Skip to content

Commit

Permalink
Documentation/misc-devices/mei: Fix formatting of headings.
Browse files Browse the repository at this point in the history
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 <[email protected]>
Signed-off-by: Julian Brost <[email protected]>
Signed-off-by: Fabian Hofmann <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
julianbrost authored and Jonathan Corbet committed Jan 29, 2015
1 parent ac3e8ea commit cfba678
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 12 deletions.
7 changes: 5 additions & 2 deletions Documentation/misc-devices/mei/mei-client-bus.txt
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -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:

Expand Down
27 changes: 17 additions & 10 deletions Documentation/misc-devices/mei/mei.txt
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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).

Expand Down Expand Up @@ -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)

Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit cfba678

Please sign in to comment.