From f39d0f5c87cac947d92536fc9de8af4709774039 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Fri, 28 Mar 2014 09:52:07 -0600 Subject: Documentatin updated; fix errors in some comments --- nuttx/arch/arm/include/sama5/chip.h | 4 +-- nuttx/configs/arduino-due/README.txt | 5 ++- nuttx/configs/ea3131/README.txt | 7 ++-- nuttx/configs/ea3152/README.txt | 7 ++-- nuttx/configs/fire-stm32v2/README.txt | 11 +++--- nuttx/configs/hymini-stm32v/README.txt | 10 +++--- nuttx/configs/lincoln60/README.txt | 3 +- nuttx/configs/mbed/README.txt | 3 +- nuttx/configs/ntosd-dm320/README.txt | 3 +- nuttx/configs/nucleus2g/README.txt | 3 +- nuttx/configs/olimex-lpc-h3131/README.txt | 7 ++-- nuttx/configs/olimex-lpc1766stk/README.txt | 3 +- nuttx/configs/sam3u-ek/README.txt | 5 ++- nuttx/configs/sam4e-ek/README.txt | 5 ++- nuttx/configs/sam4l-xplained/README.txt | 5 ++- nuttx/configs/sam4s-xplained/README.txt | 5 ++- nuttx/configs/sama5d3x-ek/README.txt | 57 +++++++++++++----------------- nuttx/configs/samd20-xplained/README.txt | 5 ++- nuttx/configs/stm3210e-eval/README.txt | 10 +++--- nuttx/configs/vsn/README.txt | 10 +++--- 20 files changed, 68 insertions(+), 100 deletions(-) diff --git a/nuttx/arch/arm/include/sama5/chip.h b/nuttx/arch/arm/include/sama5/chip.h index 66d5fbf17..92a8ca2a4 100644 --- a/nuttx/arch/arm/include/sama5/chip.h +++ b/nuttx/arch/arm/include/sama5/chip.h @@ -47,7 +47,7 @@ ****************************************************************************************************/ /* SAMA5D3 Family * - * ATSAMA5D31 ATSAMA5D33 ATSAMA5D34 ATSAMA5D35 ATSAMA5D35 + * ATSAMA5D31 ATSAMA5D33 ATSAMA5D34 ATSAMA5D35 ATSAMA5D36 * ------------------------- ------------- ------------- ------------- ------------- ------------- * Pin Count 324 324 324 324 324 * Max. Operating Frequency 536 MHz 536 MHz 536 MHz 536 MHz 536 MHz @@ -64,7 +64,7 @@ * LIN 4 4 4 4 4 * SSC 2 2 2 2 2 * Ethernet 1 1 1 2 2 - * SD / eMMC 3 2 3 2 2 + * SD / eMMC 3 2 3 2 3 * Graphic LCD Yes Yes Yes - Yes * Camera Interface Yes Yes Yes Yes Yes * ADC channels 12 12 12 12 12 diff --git a/nuttx/configs/arduino-due/README.txt b/nuttx/configs/arduino-due/README.txt index f5ed07ffd..118e6df2d 100644 --- a/nuttx/configs/arduino-due/README.txt +++ b/nuttx/configs/arduino-due/README.txt @@ -323,8 +323,7 @@ IDEs ^^^^ NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project Makefile Build -------------- @@ -350,7 +349,7 @@ IDEs Startup files will probably cause you some headaches. The NuttX startup file is arch/arm/src/sam34/sam_vectors.S. You may need to build NuttX one time from the Cygwin command line in order to obtain the pre-built - startup object needed by RIDE. + startup object needed by an IDE. NuttX EABI "buildroot" Toolchain ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/nuttx/configs/ea3131/README.txt b/nuttx/configs/ea3131/README.txt index abc9af883..2e4475d85 100644 --- a/nuttx/configs/ea3131/README.txt +++ b/nuttx/configs/ea3131/README.txt @@ -115,8 +115,7 @@ IDEs ^^^^ NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- @@ -140,9 +139,9 @@ IDEs on the command line. Startup files will probably cause you some headaches. The NuttX startup file - is arch/arm/src/lpc31xx/lpc31_vectors.S. With RIDE, I have to build NuttX + is arch/arm/src/lpc31xx/lpc31_vectors.S. You may have to build NuttX one time from the Cygwin command line in order to obtain the pre-built - startup object needed by RIDE. + startup object needed by an IDE. NuttX buildroot Toolchain ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/nuttx/configs/ea3152/README.txt b/nuttx/configs/ea3152/README.txt index c5d3a544f..b678f1a45 100644 --- a/nuttx/configs/ea3152/README.txt +++ b/nuttx/configs/ea3152/README.txt @@ -114,8 +114,7 @@ IDEs ^^^^ NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project Makefile Build -------------- @@ -139,9 +138,9 @@ IDEs on the command line. Startup files will probably cause you some headaches. The NuttX startup file - is arch/arm/src/lpc31xx/lpc31_vectors.S. With RIDE, I have to build NuttX + is arch/arm/src/lpc31xx/lpc31_vectors.S. You may have to build NuttX one time from the Cygwin command line in order to obtain the pre-built - startup object needed by RIDE. + startup object needed by an IDE. NuttX buildroot Toolchain ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/nuttx/configs/fire-stm32v2/README.txt b/nuttx/configs/fire-stm32v2/README.txt index 5ae0a65cb..8df4dcf89 100644 --- a/nuttx/configs/fire-stm32v2/README.txt +++ b/nuttx/configs/fire-stm32v2/README.txt @@ -165,9 +165,7 @@ Development Environment Either Linux or Cygwin on Windows can be used for the development environment. The source has been built only using the GNU toolchain (see below). Other toolchains will likely cause problems. Testing was performed using the Cygwin - environment because the CodeSourcery Toolchain. The Raisonance R-Link - emulatator and some RIDE7 development tools were used and those tools works - only under Windows. + environment because the CodeSourcery Toolchain. GNU Toolchain Options ===================== @@ -273,8 +271,7 @@ IDEs ==== NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- @@ -298,9 +295,9 @@ IDEs on the command line. Startup files will probably cause you some headaches. The NuttX startup file - is arch/arm/src/stm32/stm32_vectors.S. With RIDE, I have to build NuttX + is arch/arm/src/stm32/stm32_vectors.S. You many have to build NuttX one time from the Cygwin command line in order to obtain the pre-built - startup object needed by RIDE. + startup object needed by an IDE. NuttX EABI "buildroot" Toolchain ================================ diff --git a/nuttx/configs/hymini-stm32v/README.txt b/nuttx/configs/hymini-stm32v/README.txt index cd64dcf0d..0db9d1690 100644 --- a/nuttx/configs/hymini-stm32v/README.txt +++ b/nuttx/configs/hymini-stm32v/README.txt @@ -25,8 +25,7 @@ Development Environment Either Linux or Cygwin on Windows can be used for the development environment. The source has been built only using the GNU toolchain (see below). Other toolchains will likely cause problems. Testing was performed using the Cygwin - environment because the Raisonance R-Link emulatator and some RIDE7 development tools - were used and those tools works only under Windows. + environment. GNU Toolchain Options ===================== @@ -94,8 +93,7 @@ IDEs ==== NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- @@ -119,9 +117,9 @@ IDEs on the command line. Startup files will probably cause you some headaches. The NuttX startup file - is arch/arm/src/stm32/stm32_vectors.S. With RIDE, I have to build NuttX + is arch/arm/src/stm32/stm32_vectors.S. You many have to build NuttX one time from the Cygwin command line in order to obtain the pre-built - startup object needed by RIDE. + startup object needed by an IDE. NuttX EABI "buildroot" Toolchain ================================ diff --git a/nuttx/configs/lincoln60/README.txt b/nuttx/configs/lincoln60/README.txt index 797dcd187..ef2e2bf52 100644 --- a/nuttx/configs/lincoln60/README.txt +++ b/nuttx/configs/lincoln60/README.txt @@ -118,8 +118,7 @@ IDEs ^^^^ NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- diff --git a/nuttx/configs/mbed/README.txt b/nuttx/configs/mbed/README.txt index 64f93aaf2..67aff2340 100644 --- a/nuttx/configs/mbed/README.txt +++ b/nuttx/configs/mbed/README.txt @@ -88,8 +88,7 @@ IDEs ^^^^ NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- diff --git a/nuttx/configs/ntosd-dm320/README.txt b/nuttx/configs/ntosd-dm320/README.txt index 8a3205154..181affa9b 100644 --- a/nuttx/configs/ntosd-dm320/README.txt +++ b/nuttx/configs/ntosd-dm320/README.txt @@ -134,8 +134,7 @@ IDEs ^^^^ NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- diff --git a/nuttx/configs/nucleus2g/README.txt b/nuttx/configs/nucleus2g/README.txt index 781fdf503..bc16e9cfd 100644 --- a/nuttx/configs/nucleus2g/README.txt +++ b/nuttx/configs/nucleus2g/README.txt @@ -148,8 +148,7 @@ IDEs ^^^^ NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- diff --git a/nuttx/configs/olimex-lpc-h3131/README.txt b/nuttx/configs/olimex-lpc-h3131/README.txt index 21f09f9c5..8aaf34881 100644 --- a/nuttx/configs/olimex-lpc-h3131/README.txt +++ b/nuttx/configs/olimex-lpc-h3131/README.txt @@ -120,8 +120,7 @@ IDEs ==== NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- @@ -145,9 +144,9 @@ IDEs on the command line. Startup files will probably cause you some headaches. The NuttX startup file - is arch/arm/src/lpc31xx/lpc31_vectors.S. With RIDE, I have to build NuttX + is arch/arm/src/lpc31xx/lpc31_vectors.S. You may have to build NuttX one time from the Cygwin command line in order to obtain the pre-built - startup object needed by RIDE. + startup object needed by an IDE. NuttX buildroot Toolchain ========================= diff --git a/nuttx/configs/olimex-lpc1766stk/README.txt b/nuttx/configs/olimex-lpc1766stk/README.txt index a4ab8b8b2..a93302b5d 100644 --- a/nuttx/configs/olimex-lpc1766stk/README.txt +++ b/nuttx/configs/olimex-lpc1766stk/README.txt @@ -234,8 +234,7 @@ IDEs ^^^^ NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- diff --git a/nuttx/configs/sam3u-ek/README.txt b/nuttx/configs/sam3u-ek/README.txt index 34dbc8cb8..6e9917a25 100644 --- a/nuttx/configs/sam3u-ek/README.txt +++ b/nuttx/configs/sam3u-ek/README.txt @@ -98,8 +98,7 @@ IDEs ^^^^ NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- @@ -125,7 +124,7 @@ IDEs Startup files will probably cause you some headaches. The NuttX startup file is arch/arm/src/sam34/sam_vectors.S. You may need to build NuttX one time from the Cygwin command line in order to obtain the pre-built - startup object needed by RIDE. + startup object needed by an IDE. NuttX EABI "buildroot" Toolchain ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/nuttx/configs/sam4e-ek/README.txt b/nuttx/configs/sam4e-ek/README.txt index fb343ee2c..1e8a78875 100644 --- a/nuttx/configs/sam4e-ek/README.txt +++ b/nuttx/configs/sam4e-ek/README.txt @@ -95,8 +95,7 @@ IDEs ==== NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- @@ -122,7 +121,7 @@ IDEs Startup files will probably cause you some headaches. The NuttX startup file is arch/arm/src/sam34/sam_vectors.S. You may need to build NuttX one time from the Cygwin command line in order to obtain the pre-built - startup object needed by RIDE. + startup object needed by an IDE. NuttX EABI "buildroot" Toolchain ================================ diff --git a/nuttx/configs/sam4l-xplained/README.txt b/nuttx/configs/sam4l-xplained/README.txt index 677e793d2..2ab25fcd7 100644 --- a/nuttx/configs/sam4l-xplained/README.txt +++ b/nuttx/configs/sam4l-xplained/README.txt @@ -258,8 +258,7 @@ IDEs ^^^^ NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- @@ -285,7 +284,7 @@ IDEs Startup files will probably cause you some headaches. The NuttX startup file is arch/arm/src/sam34/sam_vectors.S. You may need to build NuttX one time from the Cygwin command line in order to obtain the pre-built - startup object needed by RIDE. + startup object needed by an IDE. NuttX EABI "buildroot" Toolchain ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/nuttx/configs/sam4s-xplained/README.txt b/nuttx/configs/sam4s-xplained/README.txt index 15d581926..6f2716458 100644 --- a/nuttx/configs/sam4s-xplained/README.txt +++ b/nuttx/configs/sam4s-xplained/README.txt @@ -151,8 +151,7 @@ IDEs ^^^^ NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- @@ -178,7 +177,7 @@ IDEs Startup files will probably cause you some headaches. The NuttX startup file is arch/arm/src/sam34/sam_vectors.S. You may need to build NuttX one time from the Cygwin command line in order to obtain the pre-built - startup object needed by RIDE. + startup object needed by an IDE. NuttX EABI "buildroot" Toolchain ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/nuttx/configs/sama5d3x-ek/README.txt b/nuttx/configs/sama5d3x-ek/README.txt index fa9434011..ace70ddb6 100644 --- a/nuttx/configs/sama5d3x-ek/README.txt +++ b/nuttx/configs/sama5d3x-ek/README.txt @@ -66,7 +66,6 @@ Contents - GNU Toolchain Options - IDEs - NuttX EABI "buildroot" Toolchain - - NuttX OABI "buildroot" Toolchain - NXFLAT Toolchain - Loading Code into SRAM with J-Link - Writing to FLASH using SAM-BA @@ -129,12 +128,9 @@ GNU Toolchain Options CONFIG_ARMV7A_TOOLCHAIN_GNU_EABIW=y : Generic GCC ARM EABI toolchain for Windows The CodeSourcery GCC toolchain is selected with - CONFIG_ARMV7A_TOOLCHAIN_GNU_EABIW=y and setting the PATH variable + CONFIG_ARMV7A_TOOLCHAIN_CODESOURCERYW=y and setting the PATH variable appropriately. - If you are not using AtmelStudio GCC toolchain, then you may also have to - modify the PATH in the setenv.h file if your make cannot find the tools. - NOTE about Windows native toolchains ------------------------------------ @@ -165,20 +161,11 @@ GNU Toolchain Options MKDEP = $(TOPDIR)/tools/mknulldeps.sh - NOTE 1: Older CodeSourcery toolchains (2009q1) do not work with default - optimization level of -Os (See Make.defs). It will work with -O0, -O1, or - -O2, but not with -Os. - - NOTE 2: The devkitARM toolchain includes a version of MSYS make. Make sure that - the paths to Cygwin's /bin and /usr/bin directories appear BEFORE the devkitARM - path or will get the wrong version of make. - IDEs ==== NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- @@ -204,7 +191,7 @@ IDEs Startup files will probably cause you some headaches. The NuttX startup file is arch/arm/src/sam34/sam_vectors.S. You may need to build NuttX one time from the Cygwin command line in order to obtain the pre-built - startup object needed by RIDE. + startup object needed by an IDE. NuttX EABI "buildroot" Toolchain ================================ @@ -230,9 +217,23 @@ NuttX EABI "buildroot" Toolchain 4. cd /buildroot - 5. cp configs/cortexm3-eabi-defconfig-4.6.3 .config + 5. Copy the configuration file from the configs/ sub-directory to the + top-level build directory: - 6. make oldconfig + cp configs/cortexa8-eabi-defconfig-4.8.2 .config + + 6a. You may wish to modify the configuration before you build it. For + example, it is recommended that you build the kconfig-frontends tools, + generomfs, and the NXFLAT tools as well. You may also want to change + the selected toolchain. These reconfigurations can all be done with + + make menuconfig + + 6b. If you chose to make the configuration with no changes, then you + should still do the following to make certain that the build + configuration is up-to-date: + + make oldconfig 7. make @@ -243,21 +244,6 @@ NuttX EABI "buildroot" Toolchain details PLUS some special instructions that you will need to follow if you are building a Cortex-M3 toolchain for Cygwin under Windows. - NOTE: Unfortunately, the 4.6.3 EABI toolchain is not compatible with the - the NXFLAT tools. See the top-level TODO file (under "Binary loaders") for - more information about this problem. If you plan to use NXFLAT, please do not - use the GCC 4.6.3 EABI toochain; instead use the GCC 4.3.3 OABI toolchain. - See instructions below. - -NuttX OABI "buildroot" Toolchain -================================ - - The older, OABI buildroot toolchain is also available. To use the OABI - toolchain, use the build instructions above, but (1) modify the - cortexm3-eabi-defconfig-4.6.3 configuration to use OABI (using 'make - menuconfig'), or (2) use an existing OABI configuration such as - cortexm3-defconfig-4.3.3 - NXFLAT Toolchain ================ @@ -291,6 +277,11 @@ NXFLAT Toolchain 8. Edit setenv.h, if necessary, so that the PATH variable includes the path to the newly built NXFLAT binaries. + NOTE: There are some known incompatibilities with 4.6.3 EABI toolchain + and the NXFLAT tools. See the top-level TODO file (under "Binary + loaders") for more information about this problem. If you plan to use + NXFLAT, please do not use the GCC 4.6.3 EABI toochain. + Loading Code into SRAM with J-Link ================================== diff --git a/nuttx/configs/samd20-xplained/README.txt b/nuttx/configs/samd20-xplained/README.txt index 6fdbe96fe..c3876bff3 100644 --- a/nuttx/configs/samd20-xplained/README.txt +++ b/nuttx/configs/samd20-xplained/README.txt @@ -297,8 +297,7 @@ IDEs ^^^^ NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- @@ -324,7 +323,7 @@ IDEs Startup files will probably cause you some headaches. The NuttX startup file is arch/arm/src/sam34/sam_vectors.S. You may need to build NuttX one time from the Cygwin command line in order to obtain the pre-built - startup object needed by RIDE. + startup object needed by an IDE. NuttX EABI "buildroot" Toolchain ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/nuttx/configs/stm3210e-eval/README.txt b/nuttx/configs/stm3210e-eval/README.txt index d638c7f89..d1f004b13 100644 --- a/nuttx/configs/stm3210e-eval/README.txt +++ b/nuttx/configs/stm3210e-eval/README.txt @@ -28,8 +28,7 @@ Development Environment Either Linux or Cygwin on Windows can be used for the development environment. The source has been built only using the GNU toolchain (see below). Other toolchains will likely cause problems. Testing was performed using the Cygwin - environment because the Raisonance R-Link emulatator and some RIDE7 development tools - were used and those tools works only under Windows. + environment. GNU Toolchain Options ===================== @@ -97,8 +96,7 @@ IDEs ==== NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- @@ -122,9 +120,9 @@ IDEs on the command line. Startup files will probably cause you some headaches. The NuttX startup file - is arch/arm/src/stm32/stm32_vectors.S. With RIDE, I have to build NuttX + is arch/arm/src/stm32/stm32_vectors.S. You may have to build NuttX one time from the Cygwin command line in order to obtain the pre-built - startup object needed by RIDE. + startup object needed by an IDE. NuttX EABI "buildroot" Toolchain ================================ diff --git a/nuttx/configs/vsn/README.txt b/nuttx/configs/vsn/README.txt index 9e5256d55..7457800d9 100644 --- a/nuttx/configs/vsn/README.txt +++ b/nuttx/configs/vsn/README.txt @@ -25,8 +25,7 @@ Development Environment Either Linux or Cygwin on Windows can be used for the development environment. The source has been built only using the GNU toolchain (see below). Other toolchains will likely cause problems. Testing was performed using the Cygwin - environment because the Raisonance R-Link emulatator and some RIDE7 development tools - were used and those tools works only under Windows. + environment. GNU Toolchain Options ^^^^^^^^^^^^^^^^^^^^^ @@ -94,8 +93,7 @@ IDEs ^^^^ NuttX is built using command-line make. It can be used with an IDE, but some - effort will be required to create the project (There is a simple RIDE project - in the RIDE subdirectory). + effort will be required to create the project. Makefile Build -------------- @@ -119,9 +117,9 @@ IDEs on the command line. Startup files will probably cause you some headaches. The NuttX startup file - is arch/arm/src/stm32/stm32_vectors.S. With RIDE, I have to build NuttX + is arch/arm/src/stm32/stm32_vectors.S. You may have to build NuttX one time from the Cygwin command line in order to obtain the pre-built - startup object needed by RIDE. + startup object needed by an IDE. NuttX EABI "buildroot" Toolchain ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- cgit v1.2.3