#
# Copyright (C) 2015 Annapurna Labs Ltd.
#
# This file may be licensed under the terms of the Annapurna Labs Commercial
# License Agreement.
#
# Alternatively, this file can be distributed under the terms of the GNU General
# Public License V2 as published by the Free Software Foundation and can be
# found at http://www.gnu.org/licenses/gpl-2.0.html
#
# Alternatively, redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following conditions are
# met:
#
# *     Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# *     Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#

AL-HAL - Annapurna Labs Hardware Abstraction Layer - version 2.9

This a GA release

=============================================================================
Overview
=============================================================================
The Hardware Abstraction Layer is a collection of Operating System independent
low-level drivers, those drivers provide a SW API for the underlying hardware,
and OS specific device drivers can use it to provide I/O services.
Using the HAL drivers for implementing OS specific drivers will significantly
reduce the development process. The HAL drivers save the developer the time,
effort and knowledge needed to develop and test the code that directly manages
the hardware.

=============================================================================
Package Contents
=============================================================================
drivers/		Components directory with the Code HAL driver and
			hardware register header files, if exist.

include/		Components directory with an API and common library
			header files.

doc/			Doxygen API documentation for the HAL package (see
			doc/html/index.html).

samples/		Sample code for the OS service layer.

Makefile		An example makefile to build the HAL package.

=============================================================================
QuickStart
=============================================================================
Reading the documentation:
-------------------------_
Pre-built Doxygen documentation is provided in this package. In order to read
it open 'doc/html/index.html' with an internet browser.

Building the package:
--------------------_
In order to build the package natively enter 'make'. Cross compiling the package
might require modifications for the Makefile.

Building the package documentation:
-----------------------------------
In order to build the package documentation enter 'make doc'. This will require
'doxygen' to be installed and found in the environment "PATH".