documentation.h

avr32100.zip Embedded demo

/*This file has been prepared for Doxygen automatic documentation generation.*/
/*! \file *********************************************************************
 *
 * \brief USART example application.
 *
 * This file gives an example of using the USART driver to send data to a terminal. 
 * It sends a text string.
 *
 * - Compiler:           IAR EWAAVR32 and GNU GCC for AVR32
 * - Supported devices:  All AVR32 devices with a SPI module can be used.
 *                       The example is written for AP7000 and STK1000.
 * - AppNote:            AVR32100 communication with the AVR32 USART
 *
 * \author               Atmel Corporation: http://www.atmel.com \n
 *                       Support email: [e-mail]
 *
 * $Name$
 * $Revision: 67 $
 * $RCSfile$
 * $Date: 2006-05-10 15:00:07 +0200 (Wed, 10 May 2006) $
 *****************************************************************************/

/*! \page License
 * Copyright (c) 2006, Atmel Corporation All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. The name of ATMEL may not be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY ATMEL ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY AND
 * SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*! \mainpage
* \section intro Introduction
* This is the documentation for the data structures, functions, variables,
* defines, enums, and typedefs in the software for application note AVR32100.
* It also gives an example of the usage of the USART driver
*
* \section compinfo Compilation Info
* This software was written for the GNU GCC for AVR32 and IAR Systems compiler
* for AVR32. Other compilers may or may not work.
*
* \section deviceinfo Device Info
* All AVR32 devices with a USART module can be used. This example has been tested
* with the following setup:
*
* - STK1000 development kit
* - AP7000 top board for STK1000 development kit
*
* \section setupinfo Setup Information
* CPU speed: <i>20 MHz</i>
*
*
* - The header \b SW2 must be jumped to USART1, as this is connected to the connector 
*   UART_A on the STK1000.
* - Connect USART_A to your serial port via a standard rs-232 D-SUB9 cable
* - Set the following settings in your terminal of choice: 115200 8N1
*
* \section applicationUsage Application Usage
*
* The device will start up and initialize the USART module, then send a string.
*
* \section contactinfo Contact Info
* For more info about Atmel AVR32 visit
* <A href="http://www.atmel.com/products/AVR32/" >Atmel AVR32</A> \n
* <A href="http://www.atmel.com/dyn/products/app_notes.asp?family_id=682">
* AVR32 Application Notes</A>\n
* Support mail: [e-mail]
*/