summaryrefslogtreecommitdiff
path: root/Demo/AVR32_UC3/documentation.h
blob: aefc799bed22aaac2898e31991155eb2b191b0f8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/*This file is prepared for Doxygen automatic documentation generation.*/
/*! \file *********************************************************************
 *
 * \brief FreeRTOS application example for AVR32 UC3.
 *
 * - Compiler:           IAR EWAVR32 and GNU GCC for AVR32
 * - Supported devices:  All AVR32 devices can be used.
 * - AppNote:
 *
 * \author               Atmel Corporation: http://www.atmel.com \n
 *                       Support and FAQ: http://support.atmel.no/
 *
 ******************************************************************************/

/*! \mainpage
 * \section intro Introduction
 *
 * This is the documentation for the data structures, functions, variables,
 * defines, enums, and typedefs for the FreeRTOS application.
 *
 * \image html freertos.gif
 *
 * FreeRTOS.orgTM is a portable, open source, mini Real Time Kernel - a
 * free to download and royalty free RTOS that can be used in commercial
 * applications (see license text). This site shows how a complete embedded
 * real time system can be created from a Windows host using quality open
 * source development tools (where available). See the FreeRTOS.org features
 * summary.
 * Highlights include:
 * - Free RTOS kernel - preemptive, cooperative and hybrid configuration options.
 * - Designed to be small, simple and easy to use.
 * - Very portable code structure predominantly written in C.
 * - Supports both tasks and co-routines.
 * - No software restriction on the number of tasks that can be created.
 * - No software restriction on the number of priorities that can be used.
 * - No restrictions imposed on priority assignment - more than one task can be assigned the same priority.
 * - Queues and semaphores for communication and synchronisation between tasks, or between tasks and interrupts.
 * - Free embedded software source code.
 * - Royalty free.
 * - Cross development from a standard Windows host.
 * - Pre-configured demo applications for selected single board computers allowing 'out of the box' operation and fast learning curve.
 * - Compile time configuration allows small FLASH footprint
 * - The SafeRTOS derivative product provides a high level of confidence in the code integrity.
 *
 * \section files Main Files
 * - main.c : FreeRTOS example
 *
 * \section compilinfo Compilation Information
 * This software is written for GNU GCC for AVR32 and for IAR Embedded Workbench
 * for Atmel AVR32. Other compilers may or may not work.
 *
 * \section deviceinfo Device Information
 * All AVR32 devices can be used.
 *
 * \section configinfo Configuration Information
 * This example has been tested with the following configuration:
 * - EVK1100 evaluation kit;
 * - CPU clock: 12 MHz;
 * - USART0 connected to a PC serial port via a standard RS232 DB9 cable;
 * - PC terminal settings:
 *   - 57600 bps,
 *   - 8 data bits,
 *   - no parity bit,
 *   - 1 stop bit,
 *   - no flow control.
 *
 * \section contactinfo Contact Information
 * For further information, visit
 * <A href="http://www.atmel.com/products/AVR32/" >Atmel AVR32</A>. and
 * <A href="http://www.freertos.org/" >FreeRTOS home page</A>.\n
 * Support and FAQ: http://support.atmel.no/
 */