/* ------------------------------------------------------------------------------------------------ */
/* FILE :        readme.txt                                                                         */
/*                                                                                                  */
/* CONTENTS :                                                                                       */
/*               Abassi RTOS: description for ARM Cortex M4 / IAR                                   */
/*                                                                                                  */
/*                                                                                                  */
/* 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 are located in the folder ./src
   - Demo #12, #13 #112 #113 file system is located in ./fs
   - The IAR workspace is ./Abassi.eww
   - All demo projects & binaries are located in individual folders in ./Projects


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

   - THE DEBUGGER USED FOR ALL DEMOS IS ST-LINK
     If using another one, change the set-up in the debug menu

   - On the STM3220G development board , Demos #9, #12, #13, #112 and #113 cannot use the RS-232
     as they are accessing the SD/MMC. Jumper J22 must be removed and the I/O be performed through
     semi-hosting. To access the normal UART input/output, the debugger must be used and the
     terminal I/O window opened.
          - In the debugging window, use the pull-down "View" Menu, then select "Terminal I/O"

   - "Make" or "Rebuild All" will do nothing as the .out files are provided in the project folder
     under Debug\Exe and the .out have no dependencies.

   - To download the demo executable on the target plaform, perform one of the followings:
     1) Set the desired demo as the active application: Right click on the desired project
                                                        Choose "Set as Active"
       Pull down menu "Project"
       Highlight "Download"
       Select "Download active application"

     2) Set the desired demo as the active application: Right click on the desired project
                                                        Choose "Set as Active"
       Pull down menu "Project" and select "Download and Debug"
             -- OR --
       Ctrl-D
             -- OR --
       Start a debug session with the "Download and Debug" icon at the top

   - Demos #12, #13, #112 and #113 requires a few files on the SD/MMC card.
     Make sure to use a Fat32 formatted SD/MMC card and copy all the contents of ./fs on the
     SD/MMC card.  Without these files on the card, the demo will fail as they are the html files
     the demo uses.

   - The Olimex SD/MMC driver does not properly handle SD/MMC cards with block sizes different
     than 512. If there is a file system mounting failure, the culprit is most likely the block
     size of the SD/MMC card used.

   - The Olimex STM32-P407 board has two RS232 ports.  All demos use RS232-1 port.


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

. --- / --- readme.txt    [me]
      |
      / --- Abassi.eww    [IAR IDE Workspace]
      |
      / --- fs            [Files for Demo #12, #13, #112 and #113]
      |
      / --- Projects      [All projects of the workspace are in this folder]
      |
      / --- src           [Demo source code]


/* ------------------------------------------------------------------------------------------------ */
/* 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 */

