File README of Package intel-iamt-heci

/+---------------------------------------------------------------------------
//
//  Copyright (C) Intel Corporation, 2003 - 2007.
//
//  File:       README 
//
//  Contents:   a short description for developers
//
//----------------------------------------------------------------------------

Intel(R) Manageability Engine Interface Driver
===========================

The Intel(R) Manageability Engine Interface driver allows applications to access
the Intel(R) Active Management Technology (Intel(R) AMT) FW via host
interface (as opposed to a network interface).

The Intel(R) Manageability Engine Interface driver is meant to be used by the
Local Manageability Service. When the Intel AMT machine is in Legacy Mode,
the Intel(R) Manageability Engine Interface driver functions as the KCS driver
did for Intel AMT Release 1.0.

Messages from the Intel(R) Manageability Engine Interface driver will be sent
to the system's log (i.e. /var/log/messages).

Building and installing the Intel(R) Manageability Engine Interface driver:
-----------------------------
In order to build and install the Intel(R) Manageability Engine Interface driver,
call "make install" from the /src directory. This builds the Intel(R)
Manageability Engine Interface driver, installs it and the startup script. 
Call "make uninstall" to uninstall and remove the Intel(R) Manageability Engine 
Interface driver and the startup script. In order to load and use the driver 
call "modprobe heci" or "insmod heci.ko" and call make_node script from 
scripts/ directory. To start heci driver at system boot, startup script need  
to be added to desired runlevel.

The Intel(R) Manageability Engine Interface driver may also be built and
installed manually, by first calling "make", then "insmod heci.ko", followed
by "./make_node". Remove by calling "rmmod heci.ko".

Accessing The FW Via Intel(R) Manageability Engine Interface driver:
-----------------------------
Once the Intel(R) Manageability Engine Interface driver is running, an
application can open a file to it, connect to an application on the firmware
side, and send and receive messages to that application.