/* ------------------------------------------------------------------------------------------------ */
/* FILE :        readme.txt                                                                         */
/*                                                                                                  */
/* CONTENTS :                                                                                       */
/*               Abassi RTOS: description for AVR32A / GCC (free version)                           */
/*                                                                                                  */
/*                                                                                                  */
/* Copyright (c) 2012-2017, Code-Time Technologies Inc. All rights reserved.                        */
/*                                                                                                  */
/* Code-Time Technologies retains all right, title, and interest in and to this work                */
/*                                                                                                  */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS                          */
/* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF                                       */
/* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL                          */
/* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR                             */
/* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,                            */
/* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR                            */
/* OTHER DEALINGS IN THE SOFTWARE.                                                                  */
/*                                                                                                  */
/*                                                                                                  */
/*  $Revision: 1.1 $                                                                                */
/*  $Date: 2017/04/29 16:36:58 $                                                                    */
/*                                                                                                  */
/* ------------------------------------------------------------------------------------------------ */


Quick overview at this level:

   - The RTOS source code is located in the folder ../Abassi, one level above
   - The RTOS object code is located in the folder ./obj
   - The demos source code is located in the folder ./src
   - The drivers source code is located in the folder ../Drivers, one level above
   - The demos build options definition file (AbassiLib.h) is located in the folder ./inc
   - All demo projects are located in individual folders in ./ProjectsFree
     Projects use a makefiile, that way if Atmel Studio is not used/avbailable, it is still
     possible to use this free version of Abassi

/* ------------------------------------------------------------------------------------------------ */
/* IMPORTANT NOTES                                                                                  */

   - 3 object files are provided in ./obj
     The 2 Abassi "C" object files are named according to:
           Abassi_AVR32_????.o
                          |
                          + -- FULL : Full feature Abassi
                          + -- TINY : Reduced feature Abassi

   - These files were generated with "Optimization" set to -O3

   - The Abassi "ASM" object files is
           Abassi_AVR32A_GCC.o


   - You must always combine one pair of the above (one "C" and one "ASM"), matching the
     desired feature set of Abassi

   - For all projects, these definitions must be set:
        OS_DEMO     : must always be set to a -ve value ( < 0 ).
        TINY_ABASSI : define it when linking with Abassi_C?_D?_TINY.r82.
                      DO NOT define it when linking with Abassi_C?_D?_FULL.r82.
        OS_PLATFORM : 0x..AEA... needed by the UART driver.
                      See ../Abassi/Platform.txt if a different target platform from the EVK1101
                      is used.

   - DO NOT SET any Abassi build options (except OS_TIMER_US) otherwise there will be a mismatch
     between the RTOS data structures used in the object files and the ones used in the application
     This would likely result in a crash of the application 

     *** The objects were built using the configuration settings defined in AbassiLib.h located
         in ./inc

   - DO NOT change anything in ,/inc/AbassiLib.h

   - The application timer tick period (OS_TIMER_US) can be set to a different value from the one
     used to build the objects.  The value used in the objects is avaialble in ./inc/AbassiLib.h.
     Setting the proper value of OS_TIMER_US will convert all human time to the correct # timer ticks
     for your application.

   - When using Demo #3 with TINY, the two lowest priority tasks (ST-A & ST-B) will never run
     because the stravation protection is not turned on in the TINY version


/* ------------------------------------------------------------------------------------------------ */
/* Overall file system from at this level                                                           */

. --- / --- readme.txt        [Me]
      |
      / --- ProjectsFree      [All projects of the workspace are in this folder]
      |
      / --- inc               [Projects include files)
      |
      / --- obj               [Abassi object files)
      |
      / --- src               [Demo source code]

/* EOF */
