/* ------------------------------------------------------------------------------------------------ */
/* FILE :        readme.txt                                                                         */
/*                                                                                                  */
/* CONTENTS :                                                                                       */
/*               Abassi RTOS: descripton for ARM Cortex M3 / KEIL                                   */
/*                                                                                                  */
/*                                                                                                  */
/* Copyright (c) 2012-2014, 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: 2012/03/13 20:30:02 $                                                                    */
/*                                                                                                  */
/* ------------------------------------------------------------------------------------------------ */


Quick overview at this level:

   - The demos source code is located in the directory ./src
   - The KEIL multi-project file is ./Abassi.uvmpw
   - All demo projects are located in individual directories in ./Projects


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

   - THE DEBUGGER USED FOR MOST DEMOS IS SEGGER'S J-LINK
   - The on board TI-Stellaris port is used for the EKLM3S1968 
     If using another one, change the set-up in the debug menu

   - There is nothing to build as the .axf files are provided as demos.
     To run the demo on the target board:
        Right click on the project select "Set as Active Project"
        - Either use the "load" (Download) icon" to download the demo and then reset the target
        - Or click on the "Start/Debug Session" icon, then run
        - Or type Ctrl-F5, then run

   - Demo_2_LPC1766STK_KEIL : The clock is not operating in real time because refreshing the LCD
                              is so slow that it starves all operations. The serial port
                              configuration is also affected by the latency impact of the LCD
                              refresh.
                              Demo_3 does not suffer from starvation, it operates in real time.

   - Demo_4_LPC1766STK_KEIL : Same as Demo_2: the clock is not operating in real time as the
                              updates of the LCD starve all operations.

   - Demo #2 & #3:
        Refer to Code Time Technologies website for the meaning of the letters on the right of
        display and to have a description of the syntax for the commands to modify the
        operating set-up of mAbassi.
        e.g.
           Info        : dumps the current configuration of each task
           RRA RR 100  : sets task RRA's round robin time slice to 1.00 s 


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


. --- / --- readme.txt      [me]
      |
      / --- Abassi.uvmpw    [KEIL multi-project Workspace]
      |
      / --- Projects        [All projects of the workspace are in this folder]
      |
      / --- src             [demo source code & demo libraries]


/* ------------------------------------------------------------------------------------------------ */
/* Short description of the demos                                                                   */

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 #8    : This demo is board dependent.
             Typicaly show the use of on-board display(s) or other peripherals.

Demo #9    : Small file system system shell for FatFS.

Demo #10   : Webserver showing the use of lwIP with netconn and memory base file system.

Demo #11   : Webserver showing the use of lwIP with BSD sockets and memory base file system.

Demo #12   : Webserver showing the use of lwIP with netconn and FatFS file system.

Demo #13   : Webserver showing the use of lwIP with BSD sockets and FatFS file system.

Demo #110  : Same as Demo #10, but using the CMSIS V3.0 RTOS API over Abassi

Demo #111  : Same as Demo #11, but using the CMSIS V3.0 RTOS API over Abassi

Demo #112  : Same as Demo #12, but using the CMSIS V3.0 RTOS API over Abassi

Demo #113  : Same as Demo #13, but using the CMSIS V3.0 RTOS API over Abassi

/* EOF */
