mei: docs: move iamt docs to a iamt.rst file

Move intel amt documentation to a seprate file.

Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/Documentation/driver-api/mei/iamt.rst b/Documentation/driver-api/mei/iamt.rst
new file mode 100644 (file)
index 0000000..6dcf5b1
--- /dev/null
+++ b/Documentation/driver-api/mei/iamt.rst
@@ -0,0 +1,106 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Intel(R) Active Management Technology (Intel AMT)
+=================================================
+
+Prominent usage of the Intel ME Interface is to communicate with Intel(R)
+Active Management Technology (Intel AMT) implemented in firmware running on
+the Intel ME.
+
+Intel AMT provides the ability to manage a host remotely out-of-band (OOB)
+even when the operating system running on the host processor has crashed or
+is in a sleep state.
+
+Some examples of Intel AMT usage are:
+   - Monitoring hardware state and platform components
+   - Remote power off/on (useful for green computing or overnight IT
+     maintenance)
+   - OS updates
+   - Storage of useful platform information such as software assets
+   - Built-in hardware KVM
+   - Selective network isolation of Ethernet and IP protocol flows based
+     on policies set by a remote management console
+   - IDE device redirection from remote management console
+
+Intel AMT (OOB) communication is based on SOAP (deprecated
+starting with Release 6.0) over HTTP/S or WS-Management protocol over
+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 AMT Applications
+======================
+
+       1) Intel Local Management Service (Intel LMS)
+
+          Applications running locally on the platform communicate with Intel AMT Release
+          2.0 and later releases in the same way that network applications do via SOAP
+          over HTTP (deprecated starting with Release 6.0) or with WS-Management over
+          SOAP over HTTP. This means that some Intel AMT features can be accessed from a
+          local application using the same network interface as a remote application
+          communicating with Intel AMT over the network.
+
+          When a local application sends a message addressed to the local Intel AMT host
+          name, the Intel LMS, which listens for traffic directed to the host name,
+          intercepts the message and routes it to the Intel MEI.
+          For more information:
+          http://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide
+          Under "About Intel AMT" => "Local Access"
+
+          For downloading Intel LMS:
+          http://software.intel.com/en-us/articles/download-the-latest-intel-amt-open-source-drivers/
+
+          The Intel LMS opens a connection using the Intel MEI driver to the Intel LMS
+          firmware feature using a defined UUID and then communicates with the feature
+          using a protocol called Intel AMT Port Forwarding Protocol (Intel APF protocol).
+          The protocol is used to maintain multiple sessions with Intel AMT from a
+          single application.
+
+          See the protocol specification in the Intel AMT Software Development Kit (SDK)
+          http://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide
+          Under "SDK Resources" => "Intel(R) vPro(TM) Gateway (MPS)"
+          => "Information for Intel(R) vPro(TM) Gateway Developers"
+          => "Description of the Intel AMT Port Forwarding (APF) Protocol"
+
+       2) Intel AMT Remote configuration using a Local Agent
+
+          A Local Agent enables IT personnel to configure Intel AMT out-of-the-box
+          without requiring installing additional data to enable setup. The remote
+          configuration process may involve an ISV-developed remote configuration
+          agent that runs on the host.
+          For more information:
+          http://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide
+          Under "Setup and Configuration of Intel AMT" =>
+          "SDK Tools Supporting Setup and Configuration" =>
+          "Using the Local Agent Sample"
+
+          An open source Intel AMT configuration utility,      implementing a local agent
+          that accesses the Intel MEI driver, can be found here:
+          http://software.intel.com/en-us/articles/download-the-latest-intel-amt-open-source-drivers/
+
+
+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
+IT knows when a platform crashes even when there is a hard failure on the host.
+
+The Intel AMT Watchdog is composed of two parts:
+       1) Firmware feature - receives the heartbeats
+          and sends an event when the heartbeats stop.
+       2) Intel MEI iAMT watchdog driver - connects to the watchdog feature,
+          configures the watchdog and sends the heartbeats.
+
+The Intel iAMT watchdog MEI driver uses the kernel watchdog API to configure
+the Intel AMT Watchdog and to send heartbeats to it. The default timeout of the
+watchdog is 120 seconds.
+
+If the Intel AMT is not enabled in the firmware then the watchdog client won't enumerate
+on the me client bus and watchdog devices won't be exposed.
+
+---
+linux-mei@linux.intel.com

diff --git a/Documentation/driver-api/mei/index.rst b/Documentation/driver-api/mei/index.rst
index 35c1117d83665bd109f557d7d12e56c89d1f2c9e..d261afac68529b32fa3874afa463448a8cddfa36 100644 (file)
--- a/Documentation/driver-api/mei/index.rst
+++ b/Documentation/driver-api/mei/index.rst
@@ -20,3 +20,4 @@ Intel(R) Management Engine Interface (Intel(R) MEI)
 
    mei
    mei-client-bus
+   iamt

diff --git a/Documentation/driver-api/mei/mei.rst b/Documentation/driver-api/mei/mei.rst
index 5aa3a5e6496ae24808f4e8b61b1de07016bb296d..c7f10a4b46ff6ec51a41865e894b15c54e279996 100644 (file)
--- a/Documentation/driver-api/mei/mei.rst
+++ b/Documentation/driver-api/mei/mei.rst
@@ -17,33 +17,6 @@ Each Intel ME feature (Intel ME Client) is addressed by a GUID/UUID and
 each client has its own protocol. The protocol is message-based with a
 header and payload up to 512 bytes.
 
-Prominent usage of the Intel ME Interface is to communicate with Intel(R)
-Active Management Technology (Intel AMT) implemented in firmware running on
-the Intel ME.
-
-Intel AMT provides the ability to manage a host remotely out-of-band (OOB)
-even when the operating system running on the host processor has crashed or
-is in a sleep state.
-
-Some examples of Intel AMT usage are:
-   - Monitoring hardware state and platform components
-   - Remote power off/on (useful for green computing or overnight IT
-     maintenance)
-   - OS updates
-   - Storage of useful platform information such as software assets
-   - Built-in hardware KVM
-   - Selective network isolation of Ethernet and IP protocol flows based
-     on policies set by a remote management console
-   - IDE device redirection from remote management console
-
-Intel AMT (OOB) communication is based on SOAP (deprecated
-starting with Release 6.0) over HTTP/S or WS-Management protocol over
-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
 ================
 
@@ -169,82 +142,9 @@ The Intel MEI Driver supports the following IOCTL commands:
        in order to receive an event
 
 
-Intel ME Applications
-=====================
-
-       1) Intel Local Management Service (Intel LMS)
-
-          Applications running locally on the platform communicate with Intel AMT Release
-          2.0 and later releases in the same way that network applications do via SOAP
-          over HTTP (deprecated starting with Release 6.0) or with WS-Management over
-          SOAP over HTTP. This means that some Intel AMT features can be accessed from a
-          local application using the same network interface as a remote application
-          communicating with Intel AMT over the network.
-
-          When a local application sends a message addressed to the local Intel AMT host
-          name, the Intel LMS, which listens for traffic directed to the host name,
-          intercepts the message and routes it to the Intel MEI.
-          For more information:
-          http://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide
-          Under "About Intel AMT" => "Local Access"
-
-          For downloading Intel LMS:
-          http://software.intel.com/en-us/articles/download-the-latest-intel-amt-open-source-drivers/
-
-          The Intel LMS opens a connection using the Intel MEI driver to the Intel LMS
-          firmware feature using a defined UUID and then communicates with the feature
-          using a protocol called Intel AMT Port Forwarding Protocol (Intel APF protocol).
-          The protocol is used to maintain multiple sessions with Intel AMT from a
-          single application.
-
-          See the protocol specification in the Intel AMT Software Development Kit (SDK)
-          http://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide
-          Under "SDK Resources" => "Intel(R) vPro(TM) Gateway (MPS)"
-          => "Information for Intel(R) vPro(TM) Gateway Developers"
-          => "Description of the Intel AMT Port Forwarding (APF) Protocol"
-
-       2) Intel AMT Remote configuration using a Local Agent
-
-          A Local Agent enables IT personnel to configure Intel AMT out-of-the-box
-          without requiring installing additional data to enable setup. The remote
-          configuration process may involve an ISV-developed remote configuration
-          agent that runs on the host.
-          For more information:
-          http://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide
-          Under "Setup and Configuration of Intel AMT" =>
-          "SDK Tools Supporting Setup and Configuration" =>
-          "Using the Local Agent Sample"
-
-          An open source Intel AMT configuration utility,      implementing a local agent
-          that accesses the Intel MEI driver, can be found here:
-          http://software.intel.com/en-us/articles/download-the-latest-intel-amt-open-source-drivers/
-
-
-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
-IT knows when a platform crashes even when there is a hard failure on the host.
-
-The Intel AMT Watchdog is composed of two parts:
-       1) Firmware feature - receives the heartbeats
-          and sends an event when the heartbeats stop.
-       2) Intel MEI iAMT watchdog driver - connects to the watchdog feature,
-          configures the watchdog and sends the heartbeats.
-
-The Intel iAMT watchdog MEI driver uses the kernel watchdog API to configure
-the Intel AMT Watchdog and to send heartbeats to it. The default timeout of the
-watchdog is 120 seconds.
-
-If the Intel AMT is not enabled in the firmware then the watchdog client won't enumerate
-on the me client bus and watchdog devices won't be exposed.
 
 Supported Chipsets
 ==================
 82X38/X48 Express and newer
 
-
----
 linux-mei@linux.intel.com