git.sur5r.net Git - freertos/blob - Demo/AVR32_UC3/documentation.h

   1 /*This file is prepared for Doxygen automatic documentation generation.*/\r
   2 /*! \file *********************************************************************\r
   3  *\r
   4  * \brief FreeRTOS application example for AVR32 UC3.\r
   5  *\r
   6  * - Compiler:           IAR EWAVR32 and GNU GCC for AVR32\r
   7  * - Supported devices:  All AVR32 devices can be used.\r
   8  * - AppNote:\r
   9  *\r
  10  * \author               Atmel Corporation: http://www.atmel.com \n\r
  11  *                       Support and FAQ: http://support.atmel.no/\r
  12  *\r
  13  ******************************************************************************/\r
  14 \r
  15 /*! \mainpage\r
  16  * \section intro Introduction\r
  17  *\r
  18  * This is the documentation for the data structures, functions, variables,\r
  19  * defines, enums, and typedefs for the FreeRTOS application.\r
  20  *\r
  21  * \image html freertos.gif\r
  22  *\r
  23  * FreeRTOS.orgTM is a portable, open source, mini Real Time Kernel - a\r
  24  * free to download and royalty free RTOS that can be used in commercial\r
  25  * applications (see license text). This site shows how a complete embedded\r
  26  * real time system can be created from a Windows host using quality open\r
  27  * source development tools (where available). See the FreeRTOS.org features\r
  28  * summary.\r
  29  * Highlights include:\r
  30  * - Free RTOS kernel - preemptive, cooperative and hybrid configuration options.\r
  31  * - Designed to be small, simple and easy to use.\r
  32  * - Very portable code structure predominantly written in C.\r
  33  * - Supports both tasks and co-routines.\r
  34  * - No software restriction on the number of tasks that can be created.\r
  35  * - No software restriction on the number of priorities that can be used.\r
  36  * - No restrictions imposed on priority assignment - more than one task can be assigned the same priority.\r
  37  * - Queues and semaphores for communication and synchronisation between tasks, or between tasks and interrupts.\r
  38  * - Free embedded software source code.\r
  39  * - Royalty free.\r
  40  * - Cross development from a standard Windows host.\r
  41  * - Pre-configured demo applications for selected single board computers allowing 'out of the box' operation and fast learning curve.\r
  42  * - Compile time configuration allows small FLASH footprint\r
  43  * - The SafeRTOS derivative product provides a high level of confidence in the code integrity.\r
  44  *\r
  45  * \section files Main Files\r
  46  * - main.c : FreeRTOS example\r
  47  *\r
  48  * \section compilinfo Compilation Information\r
  49  * This software is written for GNU GCC for AVR32 and for IAR Embedded Workbench\r
  50  * for Atmel AVR32. Other compilers may or may not work.\r
  51  *\r
  52  * \section deviceinfo Device Information\r
  53  * All AVR32 devices can be used.\r
  54  *\r
  55  * \section configinfo Configuration Information\r
  56  * This example has been tested with the following configuration:\r
  57  * - EVK1100 evaluation kit;\r
  58  * - CPU clock: 12 MHz;\r
  59  * - USART0 connected to a PC serial port via a standard RS232 DB9 cable;\r
  60  * - PC terminal settings:\r
  61  *   - 57600 bps,\r
  62  *   - 8 data bits,\r
  63  *   - no parity bit,\r
  64  *   - 1 stop bit,\r
  65  *   - no flow control.\r
  66  *\r
  67  * \section contactinfo Contact Information\r
  68  * For further information, visit\r
  69  * <A href="http://www.atmel.com/products/AVR32/" >Atmel AVR32</A>. and\r
  70  * <A href="http://www.freertos.org/" >FreeRTOS home page</A>.\n\r
  71  * Support and FAQ: http://support.atmel.no/\r
  72  */\r