Linux* iamt Driver for Intel(R) Active Management Technology - KCS
==================================================================

January 13, 2005

Contents
========

- In This Release                 
- Supported Adapters
- Building and Installation
- Driver Configuration Parameters
- Additional Configurations
- Known Issues
- Support

In This Release
===============

This file describes the Linux* iamt driver for Intel(R) Active Management Technology - KCS, 
version 1.0.x. 
This driver is intended for 2.4.x kernels; it is known to build properly on 2.4.x kernels through 2.4.22. 
Intel focused testing on Intel architectures running the 2.4.21 kernel.

Supported Adapters
==================

This driver will only load successfully on adapters that are Intel(R) AMT enabled.

Building and Installation
=========================

NOTES: For the build to work properly it is important that the currently
       running kernel MATCH the version and configuration of the installed
       kernel source. If you have just recompiled your kernel, reboot the 
       system and choose the correct kernel to boot.

1. Move the driver tar file to the directory of your choice. For 
   example, use: /home/username/iamt or /usr/local/src/iamt.

2. Untar/unzip the archive by entering the following, where <x.x.x> is the 
   version number for the driver tar:

     tar xzf iamt-<x.x.x>.tar.gz

3. Change to the driver src directory by entering the following, where 
   <x.x.x> is the version number for the driver tar:

     cd iamt-<x.x.x>/src/	

4. Compile the driver module:

     make install

   The binary will be installed as one of the following: 

     /lib/modules/<kernel_version>/kernel/drivers/char/iamt.o

     /lib/modules/<kernel_version>/char/iamt.o

   The install locations listed above are the default locations. They may 
   not be correct for certain Linux distributions. 

5. Install the module:

     insmod iamt
     
6. Create /dev/iamtkcs node:

     ./make_node	
   
   This will create the node needed for working with the KCS driver.
   This script has to be run when the driver is loaded.
   
NOTE: This script will create a node which can be used only with root permissions.

Driver Configuration Parameters
===============================

The default value for each parameter is generally the recommended setting,
unless otherwise noted.

wd_timeout: Time (in seconds) for sending a WD command. Default is 40.
  The minimum value is 40 (values smaller will be ignored). The maximum value
  is 65535 (values larger will be ignored).

Additional Configurations
=========================

  If you wish to see all messages issued by the driver, including debug 
  messages, set the dmesg level to eight.

  NOTE: This setting is not saved across reboots.

Known Issues
============

  Driver Compilation
  ------------------

  When trying to compile the driver by running make install, the following
  error may occur: 

      "Linux kernel source not configured - missing version.h"

  To solve this issue, create the version.h file by going to the Linux source 
  tree and entering:

      make include/linux/version.h.

Support
=======

For general information, go to the Intel support website at:

    http://support.intel.com

If an issue is identified with the released source code on the supported
kernel with a supported adapter, email the specific information related to 
the issue to linux.nics@intel.com.

License
=======

This software program is released under the terms of a license agreement 
between you ('Licensee') and Intel. Do not use or load this software or any 
associated materials (collectively, the 'Software') until you have carefully 
read the full terms and conditions of the LICENSE located in this software 
package. By loading or using the Software, you agree to the terms of this 
Agreement. If you do not agree with the terms of this Agreement, do not 
install or use the Software.

* Other names and brands may be claimed as the property of others.
