#----------------------------------------------------------------------------
# Filename: README.txt
# $Revision: 1.4.22.1 $
#----------------------------------------------------------------------------
# INTEL CONFIDENTIAL
# Copyright (2002-2008) Intel Corporation All Rights Reserved.
# The source code contained or described herein and all documents related to
# the source code ("Material") are owned by Intel Corporation or its suppliers
# or licensors. Title to the Material remains with Intel Corporation or its
# suppliers and licensors. The Material contains trade secrets and proprietary
# and confidential information of Intel or its suppliers and licensors. The
# Material is protected by worldwide copyright and trade secret laws and
# treaty provisions. No part of the Material may be used, copied, reproduced,
# modified, published, uploaded, posted, transmitted, distributed, or
# disclosed in any way without Intel's prior express written permission.
#
# No license under any patent, copyright, trade secret or other intellectual
# property right is granted to or conferred upon you by disclosure or
# delivery of the Materials, either expressly, by implication, inducement,
# estoppel or otherwise. Any license under such intellectual property rights
# must be express and approved by Intel in writing.
#
#----------------------------------------------------------------------------
Introduction
-------------
IEGD Kernel Module (IKM) is a combination of the agpgart and DRM module for the
Intel Embedded Graphic Driver. Both module are derived from the existing source
that come together with the linux kernel but have been tweak to match the IEGD
architecture. In order to use IEG Linux Driver, both module must be present
prior to the driver. Previous method that has been used to support IEGD is
through kernel patches and separate DRM modules but now everything is in one
module and no more kernel recompilation.

Installation
------------
Installation script is provided to accomodate the installation. Script will
generate the Makefile together with compilation environment for that particular 
kernel or distro. In order to install the IKM, run the shell script provided.

	./install.sh

Installation script will detect the kernel version and based on it, point to
the proper header files location before creating the Makefile. Script then will
called Make program to start compilation process. Once compilation is done, it
will try to install it. If script is run as a normal user, script will ask for
the super user password in order to copy the generated file. After that script
will invoke,

	depmod -a

to resolve module dependencies.

uninstallation
--------------
To uninstall the IKM, run the install script with following argument:

	./install.sh uninstall

This will delete the IKM file from kernel module location and invoke

	depmod -a

to resolve dependencies for other module. Reboot might require because IKM can't
be remove through rmmod utility if previous agpgart is part of the kernel image.

debug mode
--------------
To compile IKM with debug flag turn on, run the install script with following argument:

	./install.sh debug

This will compile the IKM with debugging message enable. Note that with the
debugging turn on, IKM will spit bunch of messages to the log file. Make sure
harddisk space is enough to avoid interruption to the system.

usage
-----
In order to insert module into the kernel, simply run

	modprobe iegd_mod

This will load all the modules that iegd_mod depends on before loading iegd_mod
itself. 
