//*****************************************************************************
//! @file       intro.dox
//! @brief      SmartRF06EB Board Support Package Introduction.
//!
//! Revised     $Date: 2012-05-03 14:55:14 +0200 (to, 03 mai 2012) $
//! Revision    $Revision: 7500 $
//
//  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
//
//
//  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.
//
//    Neither the name of Texas Instruments Incorporated nor the names of
//    its contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
//  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.
//****************************************************************************/

/*! \page intro_chapter
\latexonly
\chapter{Introduction}
\input{intro}
\endlatexonly
*/

/*! \page intro
<!--##### INTERNAL BEGIN #####-->
\if INTERNAL
<h1><i>***** This is the internal version of the document. *****</i></h1>
\elseif LMI
<h1><i>***** This is the public version of the document. *****</i></h1>
\elseif KEIL
<h1><i>***** This is the Keil version of the document. *****</i></h1>
\elseif IAR
<h1><i>***** This is the IAR version of the document. *****</i></h1>
\elseif CODERED
<h1><i>***** This is the code_red version of the document. *****</i></h1>
\elseif CCS
<h1><i>***** This is the CCS version of the document. *****</i></h1>
\else
<h1><i>***** This is an unknown version of the document. *****</i></h1>
\endif
<!--##### INTERNAL END #####-->

The Texas Instruments&reg;&nbsp; CCBOARD Board Support Package (BSP) for 
CCDEVICE is is a set of drivers for accessing the peripehrals found on the 
CCBOARD with the CCDEVICE family of ARM&reg;&nbsp;Cortex&tm;-M based devices. 
While the drivers are not drivers in the pure operating system sense (that is, 
they do not have a common interface and do not connect into a global device 
driver infrastructure), they do provide a mechanism that makes it easy to use 
the device's peripherals.

The capabilities and organization of the drivers are governed by the following
design goals:

- They are written entirely in C except where absolutely not possible.
- They demonstrate how to use the peripheral in its common mode of operation.
- They are easy to understand.
- They are reasonably efficient in terms of memory and processor usage.
- They are as self-contained as possible.
- Where possible, computations that can be performed at compile time are done
  there instead of at run time.\if LMI
- They can be built with more than one tool chain.\endif

Some consequences of these design goals are:

- The drivers are not necessarily as efficient as they could be (from a code
  size and/or execution speed point of view).  While the most efficient piece
  of code for operating a peripheral would be written in assembly and custom
  tailored to the specific requirements of the application, further size
  optimizations of the drivers would make them more difficult to understand.
- The drivers do not support the full capabilities of the hardware.  Some of
  the peripherals provide complex capabilities which cannot be utilized by the
  drivers in this library, though the existing code can be used as a reference
  upon which to add support for the additional capabilities.

For many applications, the drivers can be used as is.  But in some cases, the
drivers will have to be enhanced or rewritten in order to meet the
functionality, memory, or processing requirements of the application.  If so,
the existing driver can be used as a reference on how to operate the
peripheral.

The CCBOARD BSP is available for all devices in the CCDEVICE family.

\if LMI
The following tool chains are supported:

- IAR Embedded Workbench&reg;
- Texas Instruments Code Composer Studio&tm;
\endif

*/
