/* ------------------------------------------------------------------------------------------------ */
/* FILE :        readme.txt                                                                         */
/*                                                                                                  */
/* CONTENTS :                                                                                       */
/*               Abassi RTOS: description of the code distribution                                  */
/*                                                                                                  */
/*                                                                                                  */
/* Copyright (c) 2012, 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.2 $                                                                                */
/*  $Date: 2012/03/13 20:30:02 $                                                                    */
/*                                                                                                  */
/* ------------------------------------------------------------------------------------------------ */


Quick overview at this level:

   - The RTOS source code (Abassi.c & Abassi.h) is located in the directory ./Abassi
   - The Multi-core RTOS source code (mAbassi.c & mAbassi.h) is located in the directory ./Abassi
   - The demos source code is located in the directory ./Abassi_PROCESSOR_TOOL/src
   - The demos build options (AbassiDemo.h) is located in the directory ./Abassi
   - Each PROCESSOR / TOOL_CHAIN also has another readme.txt for the specific port
   - A project file for the tool chain is located in the folder ./Abassi_PROCESSOR_TOOL
     When the tool chain uses a workspace with multiple projects, the workspace is named Abassi,
     except for Atollic & CCS, the workspace is the folder named Workspace

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

   - THERE IS ANOTHER readme.txt FILE IN THE Abassi_PROCESSOR_TOOL FOLDER
     Plese read it as it contains important information on the specific PROCESSOR / TOOL_CHAIN

 
/* ------------------------------------------------------------------------------------------------ */

File system (depends on the target CPU & tool chain):

./ --- Abassi
 |
 / --- Abassi_80251_KEIL
 |
 / --- Abassi_AVR32A_GCC
 |
 / --- Abassi_AVR32A_IAR
 |
 / --- Abassi_AVR_GCC
 |
 / --- Abassi_AVR_IAR
 |
 / --- Abassi_C28X_CCS
 |
 / --- Abassi_Coldfire_IAR
 |
 / --- Abassi_CortexA9_CCS
 |
 / --- Abassi_CortexM0_ATOLLIC
 |
 / --- Abassi_CortexM0_IAR
 |
 / --- Abassi_CortexM0_KEIL
 |
 / --- Abassi_CortexM3_ATOLLIC
 |
 / --- Abassi_CortexM3_CCS
 |
 / --- Abassi_CortexM3_GCC
 |
 / --- Abassi_CortexM3_IAR
 |
 / --- Abassi_CortexM3_KEIL
 |
 / --- Abassi_CortexM4_ATOLLIC
 |
 / --- Abassi_CortexM4_IAR
 |
 / --- Abassi_CortexM4_KEIL
 |
 / --- Abassi_MSP430_CCS
 |
 / --- Abassi_MSP430_GCC
 |
 / --- Abassi_MSP430_IAR
 |
 / --- Abassi_PIC32_MPLAB
 |
 / --- asf-3.0.1 (*)                                [Atmel software framework]
 |
 / --- controlSuite (*)                             [Texas Instruments]
 |
 / --- LCD_6610
 |
 / --- lpc12xx.cmsis.driver_.library (*)            [NXP]
 |
 / --- lpc17xx.cmsis.driver.library (*)             [NXP]
 |
 / --- mAbassi_SMP_CortexA9_CCS
 |
 / --- mAbassi_SMP_CortexM3_CCS
 |
 / --- NGX
 |
 / --- StellarisWare (*)                            [Texas Instruments]
 |
 / --- STM32_P107
 | 
 / --- STM32_P207
 | 
 / --- STM32_P407
 | 
 / --- STM32F2xx_StdPeriph_Lib_V1.0.0 (*)           [ST microelectronics]
 |
 / --- STM32F4xx_DSP_StdPeriph_Lib_V1.0.1 (*)       [ST microelectronics]
 | 
 / --- STM32F10x_StdPeriph_Lib_V3.5.0 (*)           [ST microelectronics]
 |
 / --- readme.txt
 |
 ...


(*) : These libraries, supplied with the distribution, are not owned by Code Time Technologies.
      Nor does Code Time Technologies claim any right related to these libraries.
      All libraries are made available, with limitations, from the respective micro-controller
      manufacturers. Code Time Technologies provides these libraries, unaltered, as they were
      retreived from the respective websites. Some small sections of example code of these
      libraries were adapted in the demos source code; they were slightly tailored for the
      target evaluation board as an illustration how to use the libraries.


/* ------------------------------------------------------------------------------------------------ */
/* RTOS files                                                                                       */

./ --- Abassi

Abassi.c            : Complete source code for the Abassi RTOS.

Abassi.h            : Definition file for the Abassi RTOS.

AbassiDemo.h        : Build option for the demos part of the distribution.

Abassi_IAR_MTX_IF.c : IAR DLIB mutex protection wrapper (Only available for the IAR TOOLS).

cmsis_os.h          : Wrapper for CMSIS V3.0 RTOS API (ADDED VALUE for ARM processors).

cmsis_os.c          : Wrapper for CMSIS V3.0 RTOS API (ADDED VALUE for ARM processors).

mAbassi.c           : Complete source code for the multi-core mAbassi RTOS.

mAbassi.h           : Definition file for the multi-core mAbassi RTOS.


/* ------------------------------------------------------------------------------------------------ */
/* DEMO files                                                                                       */

./ --- Abassi_TARGET_TOOL --- / --- src --- / Demo_N_TARGET_TOOL.c


All demo files are named as follows:  Demo_N_TARGET_TOOL.c

where :   N      : demo number.
          TARGET : target platform / evaluation board.
          TOOL   : building tool chain name.

          The settings of the serial port for each demo is specified in the source file of the demo.



Demo #0   : Simple demo using 1 or 2 timers to flash LEDs with speed control using buttons and
            through the serial port by pressing the '+' and '-' keys.

Demo #1   : Same as Demo #0, except for boards without LEDS and/or buttons.
            The "flashing" is shown only the serial port and/or the buttons are replaced by pressing
            the '+' and '-' keys.

Demo #2   : Complex demo that shows the operations of some unique features of the Abassi RTOS.
            The operational characteristics of the tasks can be modify through the serial port.
            A thorough description is available on Code-Time Technologies website.

Demo #3   : Same as Demo #2, but for target platforms without an on-board display.
            The information is shown only the serial port.

Demo #4   : Joystick (or buttons) based demo, using every one of Abassi synchronization mechanisms.
            The joystick operation is shown on the on-board display and the serial port.

Demo #5   : Same as Demo #4, but for target platforms without an on-board display.
            The information is shown only the serial port.

Demo #6   : ADC based demo, the ADC value is is read, passed through a mailbox.
            The ADC value is shown on the on-board display and the serial port.

Demo #7   : Same as Demo #6, but for target platforms without an on-board display.
            The information is shown only on the serial port.

Demo #100 : Demo for Code Time Technologies' IP, USB and FAT File system stacks.

/* EOF */
