Generating the API documention
------------------------------

1. Generate the API documentation using the doxygen tool.

   $ doxygen

   The documentation will be generated as HTML in the html/ directory.

Building and installing on Linux
--------------------------------

1. Build and install the Operating System Kernel Abstraction (oska)
   module. Refer to the oska documentation for details.

2. Build the driver and tools using the 'generic' configuration.

   $ linux/build generic OSKADIR=<path to oska sources>

   The default for OSKADIR is ../../oska/main.

3. Install the driver and tools.

   $ sudo linux/build generic install OSKADIR=<path to oska sources>

   By default, the tools are installed in /usr/local.

Available configurations:

generic        Host running Linux kernel 2.6.x
debug          Generic with debugging enabled
arm-linux      arm-linux target running 2.6.x (must specify KDIR)

These configurations are specified in makefile fragments named
config.<config>.mk.

Useful variables include:

  Variable       Description                               Default
  KDIR           path to kernel source tree                /lib/modules/`uname -r`/build
  ARCH           kernel architecture (e.g., ARM)           unset
  CROSS_COMPILE  cross compiler prefix (e.g., arm-linux-)  unset
  O              Kbuild's O (output directory) option      unset
  V              Kbuild's V (verbosity) option             unset
  prefix         Installation tree prefix                  /usr/local

Additional configurations can be created to set any required variables
before including the appropriate generic configuration.  For example,
for an arm-linux build (with the kernel in ~/work/linux-2.6.16.28):

  KDIR := $(HOME)/work/linux-2.6.16.28

  include config.arm-linux.mk

Variables can also be specified on the command line.

  $ linux/build generic V=1
