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