]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Demo/CORTEX_A5_SAMA5D2x_Xplained_IAR/AtmelFiles/README.md
Add SAMA5D2 Xplained IAR demo.
[freertos] / FreeRTOS / Demo / CORTEX_A5_SAMA5D2x_Xplained_IAR / AtmelFiles / README.md
diff --git a/FreeRTOS/Demo/CORTEX_A5_SAMA5D2x_Xplained_IAR/AtmelFiles/README.md b/FreeRTOS/Demo/CORTEX_A5_SAMA5D2x_Xplained_IAR/AtmelFiles/README.md
new file mode 100644 (file)
index 0000000..1c7dec4
--- /dev/null
@@ -0,0 +1,166 @@
+Copyright (c) 2015, Atmel Corporation All rights reserved.\r
+----------------------------------------------------------\r
+\r
+* Redistribution and use in source and binary forms, with or without\r
+* modification, are permitted provided that the following conditions are met:\r
+*\r
+* - Redistributions of source code must retain the above copyright notice,\r
+* this list of conditions and the disclaimer below.\r
+*\r
+* Atmel's name may not be used to endorse or promote products derived from\r
+* this software without specific prior written permission.\r
+*\r
+* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR\r
+* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
+* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
+* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,\r
+* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
+* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,\r
+* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\r
+* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
+* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
+* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
+\r
+\r
+# Atmel SAMA5D2x Software Package\r
+\r
+## Overview\r
+\r
+This softpack comes as an early delivery and all presented APIs are subject to change.\r
+\r
+Each software module is provided with full source code, example of usage, and ready-to-use projects.\r
+\r
+### Supported Platforms\r
+\r
+Windows and Linux with the gnu GCC ARM Embedded toolchain. It is downloadable at this address: https://launchpad.net/gcc-arm-embedded (Mac OS X should also work but as not been tested yet).\r
+Dependencies:\r
+- GNU make (from MinGW, Cygwin or GnuWin32 for Windows architectures)\r
+- bash (from MinGW, Cygwin for Windows architectures)\r
+\r
+Windows with IAR Embedded Workbench.\r
+Dependencies:\r
+- IAR Embedded Workbench (Tested on version 7.40)\r
+- bash (from MinGW, Cygwin or GnuWin32) for IAR project generation\r
+- GNU make (from MinGW, Cygwin or GnuWin32) for IAR project generation\r
+- mktemp (from MinGW, Cygwin or GnuWin32) for IAR project generation\r
+\r
+Notice: This softpack comes as an early delivery and all presented APIs are subject to change.\r
+\r
+## Contents \r
+\r
+### Directory Architecture\r
+\r
+- target/sama5d2\r
+  All chip and board specific source files\r
+\r
+- target/sama5d2/toolchain/\r
+  Linker and debugger scripts\r
+\r
+- scripts/\r
+  generators and build script templates (Makefiles)\r
+\r
+- drivers/\r
+  Driver source files\r
+\r
+- examples/\r
+  All examples \r
+\r
+### Examples\r
+\r
+This release contains the following examples:\r
+\r
+adc: Example using ADC\r
+\r
+can: Example using CAN\r
+\r
+crypto_aes: AES hardware computation (with and without DMA)\r
+\r
+crypto_sha: SHA hardware computation (with and without DMA)\r
+\r
+crypto_tdes: Triple-DES hardware computation (with and without DMA)\r
+\r
+fifo: Test Flexcom USART FIFO\r
+\r
+gettting-started: LED blink (uses PIT and PIO)\r
+\r
+gmac: GMAC example using a simple IP stack\r
+\r
+gmac_lwip: GMAC example using LWIP stack\r
+\r
+gmac_uip_helloworld: GMAC example using UIP stack (UIP helloworld example)\r
+\r
+gmac_uip_telnetd: GMAC example using UIP stack (UIP telnetd example)\r
+\r
+gmac_uip_webserver: GMAC example using UIP stack (UIP webserver example)\r
+\r
+isc: Example using ISC controller (OV7740 sensor)\r
+\r
+lcd: Example using LCD controller\r
+\r
+qspi_flash: Read/Write/Delete commands to a QSPI serial flash\r
+\r
+rtc: RTC Example\r
+\r
+spi_serialflash: Read/Write/Delete commands to an SPI serial flash\r
+\r
+trng: Example using hardware RNG (interrupt mode)\r
+\r
+twi_eeprom: Read/Write/Delete commands to an Two-Wire EEPROM\r
+\r
+wdt: Example using watchdog timer\r
+\r
+xdma: Memory-to-memory DMA transfert example\r
+\r
+xdma_usart: Bidirectionnal Usart-memory DMA transfert example\r
+\r
+## Usage (GCC ARM Embedded)\r
+\r
+### Environment Variable\r
+\r
+TARGET: Name of the wanted target (sama5d2-xplained for samad52 XPLAINED ULTRA boards). This variable is mandatory to launch any build.\r
+\r
+DEBUG: Build with debug flags (default).\r
+\r
+TRACE_LEVEL: The wanted log level, 5 correspond to full, 0 to none (default to 5)\r
+\r
+RELEASE: Build with the release flags\r
+\r
+only TARGET must be provided or set at each make invocation.\r
+\r
+### Build\r
+\r
+Run:\r
+\r
+make\r
+#or\r
+make TARGET=wanted_target # if TARGET is not set\r
+\r
+### Run and Debug (with GDB)\r
+\r
+To run examples with gdb, first, JLinkGDBServer must be started. It can be downloaded for each platform at http://www.segger.com\r
+\r
+A make target is provided to launch the test with the correct gdb command arguments, run:\r
+\r
+make debug\r
+#or\r
+make TARGET=wanted_target debug # if TARGET is not set\r
+\r
+## Usage (IAR)\r
+\r
+The Win version of this softpack release comes with pregenerated IAR projects compatible with IAR Systems Embedded Workbench for ARM version 7.40.\r
+\r
+The C-SPY device description files and device selections files are not included and must be installed manually.\r
+\r
+### IAR Project generation\r
+\r
+An IAR project can be generated with GNU make, run in the example directory:\r
+\r
+make iar\r
+#or\r
+make TARGET=wanted_target iar # if TARGET is not set\r
+\r
+All needed IAR project files will be put in the example directory, including a default workspace one.\r
+\r
+Notice:\r
+GNU make may fail on Windows platforms if the Makefile contains UNIX line endings.\r
+You can use unix2dos on all Makefile files in scripts/ directory to fix this issue.\r